A test package for our pypackage cookiecutter.
Project description
cookiecutter-pypackage-test
A test package for our pypackage cookiecutter.
Installing
We recommend using pipx to install cookiecutter-pypackage-test. First install pipx then run:
pipx install cookiecutter-pypackage-test
You now have cookiecutter-pypackage-test installed! For some help run:
cookiecutter-pypackage-test --help
Upgrading
To upgrade to the latest version run:
pipx upgrade cookiecutter-pypackage-test
To see what version you have run:
cookiecutter-pypackage-test --version
Uninstalling
To uninstall run:
pipx uninstall cookiecutter-pypackage-test
Setting up Your cookiecutter-pypackage-test Development Environment
First you'll need to install:
- Git.
On Ubuntu:
sudo apt install git
, on macOS:brew install git
. - GNU Make.
This is probably already installed, run
make --version
to check. - pyenv. Follow the instructions in pyenv's README to install it. The Homebrew method works best on macOS. The Basic GitHub Checkout method works best on Ubuntu. You don't need to set up pyenv's shell integration ("shims"), you can use pyenv without shims.
- Docker Desktop. On Ubuntu follow Install on Ubuntu. On macOS follow Install on Mac.
Then to set up your development environment:
git clone https://github.com/hypothesis/cookiecutter-pypackage-test.git
cd cookiecutter-pypackage-test
make services
make help
Releasing a New Version of the Project
-
First, to get PyPI publishing working you need to go to: https://github.com/organizations/hypothesis/settings/secrets/actions/PYPI_TOKEN and add cookiecutter-pypackage-test to the
PYPI_TOKEN
secret's selected repositories. -
Now that the cookiecutter-pypackage-test project has access to the
PYPI_TOKEN
secret you can release a new version by just creating a new GitHub release. Publishing a new GitHub release will automatically trigger a GitHub Actions workflow that will build the new version of your Python package and upload it to https://pypi.org/project/cookiecutter-pypackage-test.
Changing the Project's Python Versions
To change what versions of Python the project uses:
-
Change the Python versions in the cookiecutter.json file. For example:
"python_versions": "3.10.4, 3.9.12",
-
Re-run the cookiecutter template:
make template
-
Commit everything to git and send a pull request
Changing the Project's Python Dependencies
To change the production dependencies in the setup.cfg
file:
-
Change the dependencies in the
.cookiecutter/includes/setuptools/install_requires
file. If this file doesn't exist yet create it and add some dependencies to it. For example:pyramid sqlalchemy celery
-
Re-run the cookiecutter template:
make template
-
Commit everything to git and send a pull request
To change the project's formatting, linting and test dependencies:
-
Change the dependencies in the
.cookiecutter/includes/tox/deps
file. If this file doesn't exist yet create it and add some dependencies to it. Use tox's factor-conditional settings to limit which environment(s) each dependency is used in. For example:lint: flake8, format: autopep8, lint,tests: pytest-faker,
-
Re-run the cookiecutter template:
make template
-
Commit everything to git and send a pull request
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.