| Name | beancount-stubs JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | Stub files for the beancount package |
| upload_time | 2024-12-15 13:43:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8.18 |
| license | Copyright 2022 Joshua Gilman Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
beancount
stubs
mypy
types
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# beancount-stubs
<p align="center">
<a href="https://github.com/jmgilman/beancount-stubs/actions/workflows/ci.yml">
<img src="https://github.com/jmgilman/beancount-stubs/actions/workflows/ci.yml/badge.svg"/>
</a>
<a href="https://pypi.org/project/beancount-stubs">
<img src="https://img.shields.io/pypi/v/beancount-stubs"/>
</a>
</p>
> A package containing stub files for the [beancount][1] package.
## Usage
Install the package:
```shell
$> pip install beancount-stubs
```
Run `mypy`:
```shell
$> mypy .
```
The `mypy` binary will automatically detect the stubs included in the installed
package and use them when asserting against the beancount package. Note that
many of the subpackages in the beancount package do not have stubs and `mypy`
will complain about the missing stubs. To disable this error on an unsupported
package, use the following syntax:
```python
from beancount.ops import validation # type: ignore
```
## Support
The following subpackages/modules are currently supported:
* `beancount.loader`
* `beancount.core.*`
* `beancount.query.numberify`
* `beancount.query.query`
* `beancount.query.query_compile`
* `beancount.query.query_execute`
## Contributing
Check out the [issues][2] for items needing attention or submit your own and
then:
1. [Fork the repo](https://github.com/jmgilman/beancount-stubs/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request
[1]: https://github.com/beancount/beancount
[2]: https://github.com/jmgilman/beancount-stubs/issues
Raw data
{
"_id": null,
"home_page": null,
"name": "beancount-stubs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8.18",
"maintainer_email": null,
"keywords": "beancount, stubs, mypy, types",
"author": null,
"author_email": "Joshua Gilman <joshuagilman@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/58/88/b2672f60c43d13d667f70da9ff656932db0ba4bbc18229d8d81e6f2b93d7/beancount_stubs-0.1.5.tar.gz",
"platform": null,
"description": "# beancount-stubs\n\n<p align=\"center\">\n <a href=\"https://github.com/jmgilman/beancount-stubs/actions/workflows/ci.yml\">\n <img src=\"https://github.com/jmgilman/beancount-stubs/actions/workflows/ci.yml/badge.svg\"/>\n </a>\n <a href=\"https://pypi.org/project/beancount-stubs\">\n <img src=\"https://img.shields.io/pypi/v/beancount-stubs\"/>\n </a>\n</p>\n\n> A package containing stub files for the [beancount][1] package.\n\n## Usage\n\nInstall the package:\n\n```shell\n$> pip install beancount-stubs\n```\n\nRun `mypy`:\n\n```shell\n$> mypy .\n```\n\nThe `mypy` binary will automatically detect the stubs included in the installed\npackage and use them when asserting against the beancount package. Note that\nmany of the subpackages in the beancount package do not have stubs and `mypy`\nwill complain about the missing stubs. To disable this error on an unsupported\npackage, use the following syntax:\n\n```python\nfrom beancount.ops import validation # type: ignore\n```\n\n## Support\n\nThe following subpackages/modules are currently supported:\n\n* `beancount.loader`\n* `beancount.core.*`\n* `beancount.query.numberify`\n* `beancount.query.query`\n* `beancount.query.query_compile`\n* `beancount.query.query_execute`\n\n## Contributing\n\nCheck out the [issues][2] for items needing attention or submit your own and\nthen:\n\n1. [Fork the repo](https://github.com/jmgilman/beancount-stubs/fork)\n2. Create your feature branch (git checkout -b feature/fooBar)\n3. Commit your changes (git commit -am 'Add some fooBar')\n4. Push to the branch (git push origin feature/fooBar)\n5. Create a new Pull Request\n\n[1]: https://github.com/beancount/beancount\n[2]: https://github.com/jmgilman/beancount-stubs/issues\n",
"bugtrack_url": null,
"license": "Copyright 2022 Joshua Gilman Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Stub files for the beancount package",
"version": "0.1.5",
"project_urls": {
"Repository": "https://github.com/jmgilman/beancount-stubs"
},
"split_keywords": [
"beancount",
" stubs",
" mypy",
" types"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ca79761928cae67433ae2ddb0529df0dd150400675afd3d422554c48f50ac5f",
"md5": "204c5c611ec72262fcdd001b236d99f1",
"sha256": "40bff4190457b5a0edbe03c6f0d385311d21c1c982e3d4e982becf735eec2efc"
},
"downloads": -1,
"filename": "beancount_stubs-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "204c5c611ec72262fcdd001b236d99f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.18",
"size": 20807,
"upload_time": "2024-12-15T13:43:28",
"upload_time_iso_8601": "2024-12-15T13:43:28.785704Z",
"url": "https://files.pythonhosted.org/packages/3c/a7/9761928cae67433ae2ddb0529df0dd150400675afd3d422554c48f50ac5f/beancount_stubs-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5888b2672f60c43d13d667f70da9ff656932db0ba4bbc18229d8d81e6f2b93d7",
"md5": "aedfb108a6068003bfa202c812db79d8",
"sha256": "7e9e2c216726bb9a69b652f9919734d4670a8e521537737339009470259a37e4"
},
"downloads": -1,
"filename": "beancount_stubs-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "aedfb108a6068003bfa202c812db79d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.18",
"size": 14638,
"upload_time": "2024-12-15T13:43:30",
"upload_time_iso_8601": "2024-12-15T13:43:30.923471Z",
"url": "https://files.pythonhosted.org/packages/58/88/b2672f60c43d13d667f70da9ff656932db0ba4bbc18229d8d81e6f2b93d7/beancount_stubs-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-15 13:43:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jmgilman",
"github_project": "beancount-stubs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "beancount-stubs"
}
