Informational Badges:

Some Linting Badges (Where I could find them):

calculator_pkg_ex

If you like the repo, it would be awesome if you could add a star to it! It really helps out the visibility. Also for any questions at all we'd love to hear from you at jfuruness@gmail.com

• Description
• Usage
• Installation
• Testing
• Development/Contributing
• Licence

Package Description

Calculator Python Package Example/Template

Usage

• calculator_pkg_ex

from a script:

from calculator_pkg_ex import Calculator
print(Calculator().add(1, 2))

Installation

• calculator_pkg_ex

Install python and pip if you have not already.

Then run:

pip3 install pip --upgrade
pip3 install wheel

For production:

pip3 install calculator_pkg_ex

This will install the package and all of it's python dependencies.

If you want to install the project for development:

git clone https://github.com/jfuruness/calculator_pkg_ex.git
cd calculator_pkg_ex
pip3 install -e ".[test]"
pre-commit install

To test the development package: Testing

Testing

• calculator_pkg_ex

To test the package after installation:

cd calculator_pkg_ex
pytest calculator_pkg_ex
ruff check calculator_pkg_ex
ruff format calculator_pkg_ex
mypy calculator_pkg_ex

If you want to run it across multiple environments:

cd calculator_pkg_ex
tox --skip-missing-interpreters

Development/Contributing

• calculator_pkg_ex

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Test it
4. Run tox
5. Commit your changes: git commit -am 'Add some feature'
6. Push to the branch: git push origin my-new-feature
7. Ensure github actions are passing tests
8. Email me at jfuruness@gmail.com if it's been a while and I haven't seen it

License

• calculator_pkg_ex

MIT License (see license file)