diff --git a/AUTHORS.rst b/AUTHORS.rst index e4368d9..f504012 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -5,9 +5,15 @@ Credits Development Lead ---------------- -* Harsh Parekh +* `hXtreme `_ : Project manager. Contributors ------------ None yet. Why not be the first? + +Special Thanks +-------------- + +* `audreyr `_ : For the `cookiecutter template `_. + diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 3190115..b5f8422 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -64,12 +64,13 @@ Ready to contribute? Here's how to set up `tasks3` for local development. $ git clone git@github.com:your_name_here/tasks3.git -3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: +3. Install your local copy into a virtualenv. Assuming you have virtualenv installed, this is how you set up your fork for local development:: - $ mkvirtualenv tasks3 $ cd tasks3/ - $ pip install -e . + $ virtualenv env + $ . ./env/bin/activate $ pip install -r requirements_dev.txt + $ pip install --editable . 4. Create a branch for local development:: @@ -77,14 +78,13 @@ Ready to contribute? Here's how to set up `tasks3` for local development. Now you can make your changes locally. -5. When you're done making changes, check that your changes pass flake8 and the +5. When you're done making changes, check that your changes match black's style, pass flake8 and the tests, including testing other Python versions with tox:: + $ black tasks3 tests $ flake8 tasks3 tests $ tox - To get flake8 and tox, just pip install them into your virtualenv. - 6. Commit your changes and push your branch to GitHub:: $ git add . @@ -126,4 +126,4 @@ $ bump2version patch # possible: major / minor / patch $ git push $ git push --tags -A github workflow will trigger if tests pass and it will deploy the package to PyPI. +Github actions will then deploy to PyPI if tests pass. diff --git a/README.rst b/README.rst index f5f0268..8dcaa1d 100644 --- a/README.rst +++ b/README.rst @@ -199,11 +199,4 @@ You can setup shell integration by adding the following command to your ``.rc`` .. note:: Pull requests to support additional shells are greatly appreciated. Please see Contributing_ page for information on how to contribute. -Credits -------- -This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. - -.. _Contributing: ./contributing.html -.. _Cookiecutter: https://github.com/audreyr/cookiecutter -.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage diff --git a/requirements_dev.txt b/requirements_dev.txt index a76390d..85c8e5c 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -9,3 +9,5 @@ Sphinx==6.2.1 sphinx-rtd-theme==1.2.2 twine==6.0.1 black==24.10.0 +pyYAML==5.4 +Click==8.1.6