Skip to content

AbhiSwamiUConn/calculator_pkg_abhinav

Repository files navigation

Informational Badges:

PyPI version PyPy PyPI - Python Version Tests Linux macOS Intel macOS ARM

Some Linting Badges (Where I could find them):

Ruff Code style: black Checked with mypy Imports: isort Pylint try/except style: tryceratops

calculator_pkg_abhinav

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

Package Description

Calculator stuff that demos pybind11

Usage

from a script:

from calculator_pkg_abhinav import FileCalculator

print(FileCalculator().sum_file())

Installation

Install python and pip if you have not already.

Then run:

pip3 install pip --upgrade
pip3 install wheel

For production:

pip3 install calculator_pkg_abhinav

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/AbhiSwamiUConn/calculator_pkg_abhinav.git
cd calculator_pkg_abhinav
pip3 install -e .[test]
pre-commit install

To test the development package: Testing

Testing

To test the package after installation:

cd calculator_pkg_abhinav
pytest calculator_pkg_abhinav
ruff check calculator_pkg_abhinav
ruff format calculator_pkg_abhinav
mypy calculator_pkg_abhinav

If you want to run it across multiple environments, and have python 3.10 and 3.11 installed:

cd calculator_pkg_abhinav
tox --skip-missing-interpreters

Development/Contributing

  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 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.

License

BSD License (see license file)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages