Skip to main content

Package configuration example using bleeding edge toolset.

Project description

fibonaci

This package allows to quickly initialise new Python package using bleeding edge tools like linters, just run:

  • pip install fibonaci
  • fibonaci <your-package-name>

Now you are able to:

  • cd <your-package-name>
  • make check # To run tests and linters
  • make publish # To publish your new package to PyPi.org to make it accessable to everyone

This is also a boilerplate for a new python package, so you can create a new package this way as well:

  • git clone git@github.com:albertas/fibonaci.git <your-package-name>
  • cd <your-package-name>
  • make init <your-package-name> - to start your modern package.

Development

Commonly used commands for package development:

  • make check - run unit tests and linters.
  • make fix - format code and fix detected fixable issues.
  • make publish - publishes current package version to pypi.org.
  • make compile - bump and freeze dependency versions in requirements*.txt files
  • make sync - upgrade installed dependencies in Virtual Environment (executed after make compile)

Toolset

This package uses these cutting edge tools:

  • ruff - for linting and code formatting
  • mypy - for type checking
  • pip-audit - for known vulnerability detection in dependencies
  • deadcode - for unused code detection
  • pytest - for collecting and running unit tests
  • coverage - for code coverage by unit tests
  • hatch - for publishing package to pypi.org
  • uv - for Python virtual environment and dependency management
  • pyproject.toml - configuration file for all tools
  • Makefile - aliases for commonly used command line commands

Feature requests:

  • Newly installed package could have virtualenv initialised.
  • Check if git is available before trying to initialise the repository.
  • remove init Makefile alias and cli.py command python files.
  • make a cli command: this package should be installable. Ideally this flow should work:
    • pip install fibonaci
    • fibonaci mynewpackage
    • cd mynewpackage && make check && make publish
  • Add pre-commit hooks with all the tools enabled.
  • codspeed.io could be considered for Continuous integration pipeline

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

fibonaci-0.0.1.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fibonaci-0.0.1-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file fibonaci-0.0.1.tar.gz.

File metadata

  • Download URL: fibonaci-0.0.1.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.2

File hashes

Hashes for fibonaci-0.0.1.tar.gz
Algorithm Hash digest
SHA256 fc459e0523c656f85bf6fa3ce6e55cfb1694c4289553f26d12c02c4a2b00f7e1
MD5 9e90a3f3bf56a2db26f53d8afd312760
BLAKE2b-256 b203c51677c8afd57908a3dd5a73a798be89266fa3aa4e89ed9b93693f41c723

See more details on using hashes here.

File details

Details for the file fibonaci-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: fibonaci-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 3.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.2

File hashes

Hashes for fibonaci-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3d40d1e856dfb58a7777962412e236f2b88a1d8d58ce8406ebe10f032d8ed1db
MD5 cda8c3dcb54dee2d78b15a9f897ac7f8
BLAKE2b-256 a54b983c4979e48750cdaf87da0d8be56e226ae7f41c062e144a68e47228b5c6

See more details on using hashes here.

Supported by

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