Skip to main content

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

  1. 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.

  2. 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:

  1. Change the Python versions in the cookiecutter.json file. For example:

    "python_versions": "3.10.4, 3.9.12",
    
  2. Re-run the cookiecutter template:

    make template
    
  3. 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:

  1. 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
    
  2. Re-run the cookiecutter template:

    make template
    
  3. Commit everything to git and send a pull request

To change the project's formatting, linting and test dependencies:

  1. 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,
    
  2. Re-run the cookiecutter template:

    make template
    
  3. Commit everything to git and send a pull request

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cookiecutter-pypackage-test-1.0.0.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file cookiecutter-pypackage-test-1.0.0.tar.gz.

File metadata

File hashes

Hashes for cookiecutter-pypackage-test-1.0.0.tar.gz
Algorithm Hash digest
SHA256 df66b20524ad1571a7735ceeb9d21666b83555679e59066d23afe4415c893739
MD5 d9946b4a5cdea2bec9f48b2e09e95467
BLAKE2b-256 ed78ccd43ba4d0a055e47d882172d7fe2b0924a85b96602b0fa20fee788439b4

See more details on using hashes here.

File details

Details for the file cookiecutter_pypackage_test-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for cookiecutter_pypackage_test-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 304c749568c3d473d458888b28bc8c364e4de6a541477efc664d9656298caa0a
MD5 81affca4e28d9a7a34b107914e9b063c
BLAKE2b-256 847f44cf25a06aa2ab2ad6d131c1811fc093264375faec4cdd9365617eab6a59

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page