Skip to main content

A test package for our pypackage cookiecutter.

Project description

test-pypackage

A test package for our pypackage cookiecutter.

Installing

We recommend using pipx to install test-pypackage. First install pipx then run:

pipx install test-pypackage

You now have test-pypackage installed! For some help run:

test-pypackage --help

Upgrading

To upgrade to the latest version run:

pipx upgrade test-pypackage

To see what version you have run:

test-pypackage --version

Uninstalling

To uninstall run:

pipx uninstall test-pypackage

Setting up Your test-pypackage 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/test-pypackage.git
cd test-pypackage
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 test-pypackage to the PYPI_TOKEN secret's selected repositories.

  2. Now that the test-pypackage 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/test-pypackage.

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

test_pypackage-1.0.1.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

test_pypackage-1.0.1-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file test_pypackage-1.0.1.tar.gz.

File metadata

  • Download URL: test_pypackage-1.0.1.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for test_pypackage-1.0.1.tar.gz
Algorithm Hash digest
SHA256 3df7f7e73bac13cde1339ef7d4265f04453c5a764c2ffa8bef4fc1fd58d830ad
MD5 4bf0797d0d0310448e7f8294f6e099bb
BLAKE2b-256 834df6bfc5f63c2b8d3df6c3db17b75e65e79d4b846916b4fcc57cfffd42101f

See more details on using hashes here.

File details

Details for the file test_pypackage-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for test_pypackage-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3eb9036ffa28175274ad3ec6b9bda4181dd4476cd561854917917237c7ff498c
MD5 493290df0871179ca193e61fd3e58f53
BLAKE2b-256 6d0094fb443297a9036279e6cf1b8ff0321f000263a9f455cb20c7242fb9d402

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