Skip to main content

A project for testing https://github.com/creditornot/wolt-python-package-cookiecutter

Project description

Just a test project

PyPI PyPI - Python Version PyPI - License Coookiecutter - Wolt


Documentation: https://creditornot.github.io/just-a-test-project

Source Code: https://github.com/creditornot/just-a-test-project

PyPI: https://pypi.org/project/just-a-test-project/


A project for testing wolt-python-package-cookiecutter

Installation

pip install just-a-test-project

Development

  • Clone this repository
  • Requirements:
  • Create a virtual environment and install the dependencies
poetry install
  • Activate the virtual environment
poetry shell

Testing

pytest

Documentation

The documentation is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code. The documentation is updated and published as a Github project page automatically as part each release.

Releasing

Trigger the Draft release workflow (press Run workflow). This will update the changelog & version and create a GitHub release which is in Draft state.

Find the draft release from the GitHub releases and publish it. When a release is published, it'll trigger release workflow which creates PyPI release and deploys updated documentation.

Pre-commit

Pre-commit hooks run all the auto-formatters (e.g. black, isort), linters (e.g. mypy, flake8), and other quality checks to make sure the changeset is in good shape before a commit/push happens.

You can install the hooks with (runs for each commit):

pre-commit install

Or if you want them to run only for each push:

pre-commit install -t pre-push

Or if you want e.g. want to run all checks manually for all files:

pre-commit run --all-files

This project was generated using the wolt-python-package-cookiecutter template.

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

just-a-test-project-0.0.30.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

just_a_test_project-0.0.30-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file just-a-test-project-0.0.30.tar.gz.

File metadata

  • Download URL: just-a-test-project-0.0.30.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.6 Linux/5.8.0-1040-azure

File hashes

Hashes for just-a-test-project-0.0.30.tar.gz
Algorithm Hash digest
SHA256 610bc72e19c36e49e7ba27d1b6364936c7f209ced16475b0bffc2f1631f4541c
MD5 02f1753544fb390224bf1444cd5e28b4
BLAKE2b-256 49c1d6b9818e9c740f05ca5cb719600324c56fbdfa6ed7b8eabfdf330fbd97fc

See more details on using hashes here.

File details

Details for the file just_a_test_project-0.0.30-py3-none-any.whl.

File metadata

File hashes

Hashes for just_a_test_project-0.0.30-py3-none-any.whl
Algorithm Hash digest
SHA256 1657f915ba35ceeb7f19ae3c62f6542bbc8ab53a6f784e1131e5420582f848ae
MD5 a4275234b33ccf374b7b8175ca9bd8e9
BLAKE2b-256 89996c0ee6e7bf1f180fe3094e092b7f29db1a8279ef999892504d9a2eb46915

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