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.2.tar.gz (4.6 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.2-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fibonaci-0.0.2.tar.gz
Algorithm Hash digest
SHA256 e8d79eed3c17f05d72b224e38474cb936b78972e2c520c8e0ed8680a2c24e07e
MD5 4dd6ccae77ca68550d4d63b3d9f3684d
BLAKE2b-256 16d56f892078530c25e30c41c8eca584ec19dd7e1fa65beb32cda1feef71b364

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for fibonaci-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e7cc46c3b58d7c0457fcefed642d4db868503255bcb5dd8dd4540ba5e10d5a98
MD5 44bda41e94c3e77f4a4b01943ff29616
BLAKE2b-256 593f2dfba0bbb19c8947e74e3ecb6c485702c7e121d6f384eed9cbb78be47960

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