Skip to content

Commit

Permalink
Updating documentation and release action to use poetry too
Browse files Browse the repository at this point in the history
  • Loading branch information
carlio committed Aug 28, 2021
1 parent 819a4a5 commit fa8a61a
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 7 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ jobs:
python-version: ${{ env.DEFAULT_PYTHON }}
- name: Install requirements
run: |
python -m pip install -U pip twine wheel
python -m pip install -U "setuptools>=56.0.0"
python -m pip install --disable-pip-version-check -U pip twine poetry
- name: Build distributions
run: |
python setup.py sdist bdist_wheel
poetry build -f wheel
poetry build -f sdist
- name: Upload to PyPI
if: github.event_name == 'release' && startsWith(github.ref, 'refs/tags')
env:
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ handling the output of other tools. However, please do run them before submittin

nosetests tests/

Prospector targets Python 3.6, 3.8, 3.9 and 3.10. You can use `tox`_ to test this locally,
Prospector targets Python 3.6, 3.7, 3.8 and 3.9. You can use `tox`_ to test this locally,
and all tests are run on `travis-ci.org`_.

.. _tox: https://tox.readthedocs.io/en/latest/
Expand Down
11 changes: 9 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,10 @@ the output depending on the libraries your project uses.
Installation
------------

Prospector can be installed using ``pip`` by running the following command::
Prospector can be installed from PyPI using ``pip`` by running the following command::

pip install prospector


Optional dependencies for Prospector, such as ``pyroma`` can also be installed by running::

pip install prospector[with_pyroma]
Expand All @@ -56,6 +55,14 @@ Some shells (such as ``Zsh``, the default shell of macOS Catalina) require brack
For a list of all of the optional dependencies, see the optional extras section on the ReadTheDocs
page on `Supported Tools Extras <https://prospector.readthedocs.io/en/latest/supported_tools.html#optional-extras>`_.

For local development, [poetry](https://python-poetry.org/) is used. Check out the code, then run::

poetry install

And for extras::

poetry install -E with_everything

For more detailed information on installing the tool, see the
`installation section <http://prospector.readthedocs.io/en/latest/#installation>`_ of the tool's main page
on ReadTheDocs.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "prospector"
version = "1.5.0.dev1"
version = "1.5.0.dev2"
description = ""
authors = ["Carl Crowder <git@carlcrowder.com>"]
maintainers = ["Carl Crowder <git@carlcrowder.com>",
Expand Down

0 comments on commit fa8a61a

Please sign in to comment.