<!-- BEGIN INCLUDE -->
# ConverterPro
A python library to convert units and currencies
[](https://github.com/oforiwaasam/converterpro/actions/workflows/build.yml)
[](https://coveralls.io/github/oforiwaasam/converterpro?branch=main)
[](https://github.com/psf/black)
[](https://python-poetry.org/)
[](https://pypi.org/project/converterpro/)
[](https://oforiwaasam.github.io/converterpro)
[](https://converterpro.readthedocs.io/en/latest/?badge=latest)
## 🔭 Overview
This python library will allow developers to easily incorporate conversions into their programs without having to write all the logic for it. The library currently has the following functionalities:
## 📝 Features
+ Weight conversion between Metric, Imperial and US Systems of Measurement
+ Grams
+ Milligrams
+ Kilograms
+ Metric Tonnes
+ Imperial Tons
+ US tons
+ Pounds
+ Ounces
## 🛠️ Installation
**converterpro** can be found on [PyPi](https://pypi.org/project/converterpro/0.1.1/) and hence can be installed with `pip`:
```bash
pip install converterpro
```
## ⛯ Basic Usage
```python3
>>> from converterpro import weight_converter
>>> my_gram = weight_converter.Gram(1.0)
>>> my_gram.convert_to_kilograms()
0.001
```
## 📝 Details
This library project is a pure python project using modern tooling. It uses a `Makefile` as a command registry, with the following commands:
+ `make`: list available commands
+ `make install`: install and build this library and its dependencies using `poetry`
+ `make lint`: perform static analysis of this library with `ruff` and `black`
+ `make format`: autoformat this library using `black` and `ruff`
+ `make test`: run automated tests with `pytest`
+ `make coverage`: run automated tests with `pytest` and collect coverage information
<!-- END INCLUDE -->
## 👩🏾💻👨🏾💻 Contributing
Please see [CONTRIBUTING](https://converterpro.readthedocs.io/en/latest/contributing/) for more information.
## 🪪 License
This software is licensed under the Apache 2.0 license. Please see [LICENSE](https://converterpro.readthedocs.io/en/latest/license/) for more information.
## 🙎🏾 Author
Main Maintainer: Lily Sam
Raw data
{
"_id": null,
"home_page": "http://converterpro.readthedocs.io/",
"name": "converterpro",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "weight-conversion,converter,oforiwaasam",
"author": "Lily Sam",
"author_email": "los2119@columbia.edu",
"download_url": "https://files.pythonhosted.org/packages/a4/17/0ea537f868d99f4ea9d80450db2d6bb96954ae4ef99a995e02f238c04042/converterpro-0.1.2.tar.gz",
"platform": null,
"description": "<!-- BEGIN INCLUDE -->\n# ConverterPro\n\nA python library to convert units and currencies\n\n\n\n[](https://github.com/oforiwaasam/converterpro/actions/workflows/build.yml)\n[](https://coveralls.io/github/oforiwaasam/converterpro?branch=main)\n[](https://github.com/psf/black)\n[](https://python-poetry.org/)\n[](https://pypi.org/project/converterpro/)\n[](https://oforiwaasam.github.io/converterpro)\n[](https://converterpro.readthedocs.io/en/latest/?badge=latest)\n\n## \ud83d\udd2d Overview\n\nThis python library will allow developers to easily incorporate conversions into their programs without having to write all the logic for it. The library currently has the following functionalities:\n\n## \ud83d\udcdd Features\n\n+ Weight conversion between Metric, Imperial and US Systems of Measurement\n + Grams\n + Milligrams\n + Kilograms\n + Metric Tonnes\n + Imperial Tons\n + US tons\n + Pounds\n + Ounces\n\n## \ud83d\udee0\ufe0f Installation\n\n**converterpro** can be found on [PyPi](https://pypi.org/project/converterpro/0.1.1/) and hence can be installed with `pip`:\n\n```bash\npip install converterpro\n```\n\n## \u26ef Basic Usage\n\n```python3\n>>> from converterpro import weight_converter\n>>> my_gram = weight_converter.Gram(1.0)\n>>> my_gram.convert_to_kilograms()\n0.001\n```\n\n## \ud83d\udcdd Details\n\nThis library project is a pure python project using modern tooling. It uses a `Makefile` as a command registry, with the following commands:\n\n+ `make`: list available commands\n+ `make install`: install and build this library and its dependencies using `poetry`\n+ `make lint`: perform static analysis of this library with `ruff` and `black`\n+ `make format`: autoformat this library using `black` and `ruff`\n+ `make test`: run automated tests with `pytest`\n+ `make coverage`: run automated tests with `pytest` and collect coverage information\n<!-- END INCLUDE -->\n\n## \ud83d\udc69\ud83c\udffe\u200d\ud83d\udcbb\ud83d\udc68\ud83c\udffe\u200d\ud83d\udcbb Contributing\n\nPlease see [CONTRIBUTING](https://converterpro.readthedocs.io/en/latest/contributing/) for more information.\n\n## \ud83e\udeaa License\n\nThis software is licensed under the Apache 2.0 license. Please see [LICENSE](https://converterpro.readthedocs.io/en/latest/license/) for more information.\n\n## \ud83d\ude4e\ud83c\udffe\u200d Author\n\nMain Maintainer: Lily Sam\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python converter library",
"version": "0.1.2",
"project_urls": {
"Homepage": "http://converterpro.readthedocs.io/",
"Repository": "https://github.com/oforiwaasam/converterpro"
},
"split_keywords": [
"weight-conversion",
"converter",
"oforiwaasam"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aad86e050b91121c0e0ff286d4aafeffe815b9b85236c8cc1fd0654075dae0fc",
"md5": "06490f1a857265daa817b7dd1f4f57d2",
"sha256": "df3d0c459c459dac2109a6cfb08e0bc573a2ecc84fc74c779a6f869baa299774"
},
"downloads": -1,
"filename": "converterpro-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "06490f1a857265daa817b7dd1f4f57d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 8244,
"upload_time": "2023-05-04T22:36:52",
"upload_time_iso_8601": "2023-05-04T22:36:52.298242Z",
"url": "https://files.pythonhosted.org/packages/aa/d8/6e050b91121c0e0ff286d4aafeffe815b9b85236c8cc1fd0654075dae0fc/converterpro-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4170ea537f868d99f4ea9d80450db2d6bb96954ae4ef99a995e02f238c04042",
"md5": "9a0e5e28cd45d0c8595b4564ff663b4c",
"sha256": "eeeee52aeb64be1e60b2e05256db9adf67831c905b0e4344fa432ff88120c550"
},
"downloads": -1,
"filename": "converterpro-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "9a0e5e28cd45d0c8595b4564ff663b4c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 8494,
"upload_time": "2023-05-04T22:36:54",
"upload_time_iso_8601": "2023-05-04T22:36:54.077213Z",
"url": "https://files.pythonhosted.org/packages/a4/17/0ea537f868d99f4ea9d80450db2d6bb96954ae4ef99a995e02f238c04042/converterpro-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-04 22:36:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oforiwaasam",
"github_project": "converterpro",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "converterpro"
}
JSON
