Informational Badges:
Some Linting Badges (Where I could find them):
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 abhinav.swaminathan@uconn.edu
Calculator stuff that demos pybind11
from a script:
from calculator_pkg_abhinav_jmf import FileCalculator
print(FileCalculator().sum_file())Install python and pip if you have not already.
Then run:
pip3 install pip --upgrade
pip3 install wheelFor production:
pip3 install calculator_pkg_abhinav_jmfThis 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/AbhiSwamiUConn/calculator_pkg_abhinav_jmf.git
cd calculator_pkg_abhinav_jmf
pip3 install -e .[test]
pre-commit installTo test the development package: Testing
To test the package after installation:
cd calculator_pkg_abhinav_jmf
pytest calculator_pkg_abhinav_jmf
ruff check calculator_pkg_abhinav_jmf
ruff format calculator_pkg_abhinav_jmf
mypy calculator_pkg_abhinav_jmf
If you want to run it across multiple environments, and have python 3.10 and 3.11 installed:
cd calculator_pkg_abhinav_jmf
tox --skip-missing-interpreters
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Test it
- Run tox
- Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Ensure github actions are passing tests
- Email me at abhinav.swaminathan@uconn.edu if it's been a while and I haven't seen it
NOTE: all contributions from other contributors are listed under the existing license for this repo unless stated otherwise, and by contributing to this repo you agree to those terms and conditions.
BSD License (see license file)