| Name | amend JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | Amend: Ensure your values are right |
| upload_time | 2025-04-20 21:58:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
amend
validation
correction
processing
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Amend
Ensure your values are right
  
## Motivation
Often times I write a lot of boilerplate code to validate and correct certain values. I have decided to create a package to stop doing it for some of the things I use. The goals of this package:
- perform routine type validation and correction (amend!)
- do not rely on third-party libraries
- if it's outside standard Python, amends should be handled by package maintainers
- do not overcomplicate things
- what can easily be done with a processing pipeline should be done with a processing pipeline
Using this, hopefully, writing argument parsers and ensuring correctness in functionality should be slightly easier, while forcing people to explicitly handle more elaborate and specific use cases.
## Installation
You can install this with pip:
```bash
pip install amend
```
Alternatively, you can install this from source:
```
git clone git@github.com:suflaj/amend.git
cd amend
pip install .
```
## Running tests
Amend uses your run-of-the-mill `unittest`. Therefore, to test the whole package, you can simply do:
```bash
python3 -m unittest amend.testing
```
If you wish to test some specific module you can reference the testing module with unittest. For example, if you want to unit test built-in amendments, do:
```bash
python3 -m unittest amend.testing.unit.built_in
```
For more info on how to use `unittest`, look [here](https://docs.python.org/3/library/unittest.html).
## Things to do
This package is in beta. For it to reach a full release it will need to receive:
- ReadTheDocs documentations
- usage examples
- some actual usage (will start to substitute my boilerplate for it)
Currently, it wasn't battle tested. I put in some effort to write it well, but not necessarily optimally. However, even though I do not recommend you use this for production, you can use it for many things, and presumably it should work. If it doesn't, [create an issue](https://github.com/suflaj/amend/issues). The format doesn't really matter currently.
Raw data
{
"_id": null,
"home_page": null,
"name": "amend",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Miljenko \u0160uflaj <suflajmob@gmail.com>",
"keywords": "amend, validation, correction, processing",
"author": null,
"author_email": "Miljenko \u0160uflaj <suflajmob@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/9a/e1/16a6d96f0373ba525be9200bf67eaa2ee6f59788a625c6b9e82bc3753af2/amend-0.3.1.tar.gz",
"platform": null,
"description": "# Amend\n\nEnsure your values are right\n\n\n\n\n\n  \n\n\n## Motivation\n\nOften times I write a lot of boilerplate code to validate and correct certain values. I have decided to create a package to stop doing it for some of the things I use. The goals of this package:\n\n- perform routine type validation and correction (amend!)\n- do not rely on third-party libraries\n - if it's outside standard Python, amends should be handled by package maintainers\n- do not overcomplicate things\n - what can easily be done with a processing pipeline should be done with a processing pipeline\n\nUsing this, hopefully, writing argument parsers and ensuring correctness in functionality should be slightly easier, while forcing people to explicitly handle more elaborate and specific use cases.\n\n## Installation\n\nYou can install this with pip:\n\n```bash\npip install amend\n```\n\nAlternatively, you can install this from source:\n```\ngit clone git@github.com:suflaj/amend.git\ncd amend\npip install .\n```\n\n## Running tests\n\nAmend uses your run-of-the-mill `unittest`. Therefore, to test the whole package, you can simply do:\n\n```bash\npython3 -m unittest amend.testing\n```\n\nIf you wish to test some specific module you can reference the testing module with unittest. For example, if you want to unit test built-in amendments, do:\n\n```bash\npython3 -m unittest amend.testing.unit.built_in\n```\n\nFor more info on how to use `unittest`, look [here](https://docs.python.org/3/library/unittest.html).\n\n## Things to do\n\nThis package is in beta. For it to reach a full release it will need to receive:\n\n- ReadTheDocs documentations\n- usage examples\n- some actual usage (will start to substitute my boilerplate for it)\n\nCurrently, it wasn't battle tested. I put in some effort to write it well, but not necessarily optimally. However, even though I do not recommend you use this for production, you can use it for many things, and presumably it should work. If it doesn't, [create an issue](https://github.com/suflaj/amend/issues). The format doesn't really matter currently.\n",
"bugtrack_url": null,
"license": null,
"summary": "Amend: Ensure your values are right",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/suflaj/amend",
"Issues": "https://github.com/suflaj/amend/issues",
"Repository": "https://github.com/suflaj/amend.git"
},
"split_keywords": [
"amend",
" validation",
" correction",
" processing"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ef4ad7b438168d294c86549f077f30a23a6365a316568f36f2c6615a32e0f42a",
"md5": "b06e8eeb88e41130aef8ccae0cd155aa",
"sha256": "7b89d9fefd06cb049ad5ad9f5a81c4c8ea36d2f10a0c1b6b005ee94b92b2c1b1"
},
"downloads": -1,
"filename": "amend-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b06e8eeb88e41130aef8ccae0cd155aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 49847,
"upload_time": "2025-04-20T21:58:17",
"upload_time_iso_8601": "2025-04-20T21:58:17.259446Z",
"url": "https://files.pythonhosted.org/packages/ef/4a/d7b438168d294c86549f077f30a23a6365a316568f36f2c6615a32e0f42a/amend-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9ae116a6d96f0373ba525be9200bf67eaa2ee6f59788a625c6b9e82bc3753af2",
"md5": "7a9079b5163492895af33369207b5137",
"sha256": "9138dcfc727aae2d96f7ddbb5b35242c6152b929775b8dc3f9fbd264f0d766a1"
},
"downloads": -1,
"filename": "amend-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "7a9079b5163492895af33369207b5137",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 31396,
"upload_time": "2025-04-20T21:58:19",
"upload_time_iso_8601": "2025-04-20T21:58:19.070965Z",
"url": "https://files.pythonhosted.org/packages/9a/e1/16a6d96f0373ba525be9200bf67eaa2ee6f59788a625c6b9e82bc3753af2/amend-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-04-20 21:58:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "suflaj",
"github_project": "amend",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "amend"
}
