# Black Cat DataBase
[](https://hitsofcode.com/github/koviubi56/bcdb/view?branch=main)
[](https://www.codacy.com/gh/koviubi56/bcdb/dashboard?utm_source=github.com&utm_medium=referral&utm_content=koviubi56/bcdb&utm_campaign=Badge_Grade)
[](https://github.com/psf/black)
Black Cat DataBase (BCDB) is a simple database.
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install bcdb. _[Need more help?](https://packaging.python.org/en/latest/tutorials/installing-packages/)_
```bash
pip install bcdb
```
## Requirements
BCDB requires Python 3.11.
## Usage
```python
import bcdb
from pathlib import Path
db = bcdb.Database(Path("database_directory"))
table = db.add_table("tablename", [
bcdb.Attribute(
"attribute1",
bcdb.AttributeType.STRING,
bcdb.AttributeRequirements.UNIQUE,
),
bcdb.Attribute(
"attribute2",
bcdb.AttributeType.FLOAT,
),
])
table.add_row(("hello", 3.14))
table.add_row(("world", -0.5))
```
For more information see the docstrings.
## Support
Questions should be asked in the [Discussions tab](https://github.com/koviubi56/bcdb/discussions/categories/q-a).
Feature requests and bug reports should be reported in the [Issues tab](https://github.com/koviubi56/bcdb/issues/new/choose).
Security vulnerabilities should be reported as described in our [Security policy](https://github.com/koviubi56/bcdb/security/policy) (the [SECURITY.md](SECURITY.md) file).
## Contributing
[Pull requests](https://github.com/koviubi56/bcdb/blob/main/CONTRIBUTING.md#pull-requests) are welcome. For major changes, please [open an issue first](https://github.com/koviubi56/bcdb/issues/new/choose) to discuss what you would like to change.
Please make sure to add entries to [the changelog](CHANGELOG.md).
For more information, please read the [contributing guidelines](CONTRIBUTING.md).
## Authors and acknowledgments
A list of nice people who helped this project can be found in the [CONTRIBUTORS file](CONTRIBUTORS).
## License
[GNU GPLv3+](LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/koviubi56/bcdb",
"name": "bcdb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "db,database",
"author": "Koviubi56",
"author_email": "koviubi56@duck.com",
"download_url": "https://files.pythonhosted.org/packages/3d/9d/130b234bc5bdaef469f48af51786de9420d98ab99e34aae923c62628a45b/bcdb-0.4.0.tar.gz",
"platform": "unix",
"description": "# Black Cat DataBase\r\n\r\n[](https://hitsofcode.com/github/koviubi56/bcdb/view?branch=main)\r\n[](https://www.codacy.com/gh/koviubi56/bcdb/dashboard?utm_source=github.com&utm_medium=referral&utm_content=koviubi56/bcdb&utm_campaign=Badge_Grade)\r\n\r\n\r\n[](https://github.com/psf/black)\r\n\r\n\r\n\r\n\r\n\r\n\r\nBlack Cat DataBase (BCDB) is a simple database.\r\n\r\n## Installation\r\n\r\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install bcdb. _[Need more help?](https://packaging.python.org/en/latest/tutorials/installing-packages/)_\r\n\r\n```bash\r\npip install bcdb\r\n```\r\n\r\n## Requirements\r\n\r\nBCDB requires Python 3.11.\r\n\r\n## Usage\r\n\r\n```python\r\nimport bcdb\r\nfrom pathlib import Path\r\n\r\ndb = bcdb.Database(Path(\"database_directory\"))\r\ntable = db.add_table(\"tablename\", [\r\n bcdb.Attribute(\r\n \"attribute1\",\r\n bcdb.AttributeType.STRING,\r\n bcdb.AttributeRequirements.UNIQUE,\r\n ),\r\n bcdb.Attribute(\r\n \"attribute2\",\r\n bcdb.AttributeType.FLOAT,\r\n ),\r\n])\r\ntable.add_row((\"hello\", 3.14))\r\ntable.add_row((\"world\", -0.5))\r\n```\r\n\r\nFor more information see the docstrings.\r\n\r\n## Support\r\n\r\nQuestions should be asked in the [Discussions tab](https://github.com/koviubi56/bcdb/discussions/categories/q-a).\r\n\r\nFeature requests and bug reports should be reported in the [Issues tab](https://github.com/koviubi56/bcdb/issues/new/choose).\r\n\r\nSecurity vulnerabilities should be reported as described in our [Security policy](https://github.com/koviubi56/bcdb/security/policy) (the [SECURITY.md](SECURITY.md) file).\r\n\r\n## Contributing\r\n\r\n[Pull requests](https://github.com/koviubi56/bcdb/blob/main/CONTRIBUTING.md#pull-requests) are welcome. For major changes, please [open an issue first](https://github.com/koviubi56/bcdb/issues/new/choose) to discuss what you would like to change.\r\n\r\nPlease make sure to add entries to [the changelog](CHANGELOG.md).\r\n\r\nFor more information, please read the [contributing guidelines](CONTRIBUTING.md).\r\n\r\n## Authors and acknowledgments\r\n\r\nA list of nice people who helped this project can be found in the [CONTRIBUTORS file](CONTRIBUTORS).\r\n\r\n## License\r\n\r\n[GNU GPLv3+](LICENSE)\r\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Black Cat DataBase is a simple database.",
"version": "0.4.0",
"split_keywords": [
"db",
"database"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26eaae6231c7e851316400e602f0ada99b22b6c92a1e2ff9000e39f50d8fd695",
"md5": "cd6e39dc2b40d0f062936a857d8b2a23",
"sha256": "05fcd24b89f2d71ec68a5d59007920b28484da8a0acd279064d9cb3a67fac423"
},
"downloads": -1,
"filename": "bcdb-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd6e39dc2b40d0f062936a857d8b2a23",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 23201,
"upload_time": "2023-04-24T13:21:50",
"upload_time_iso_8601": "2023-04-24T13:21:50.253785Z",
"url": "https://files.pythonhosted.org/packages/26/ea/ae6231c7e851316400e602f0ada99b22b6c92a1e2ff9000e39f50d8fd695/bcdb-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3d9d130b234bc5bdaef469f48af51786de9420d98ab99e34aae923c62628a45b",
"md5": "befffbc9ac2453917069d7d7dfbdf0cd",
"sha256": "b68720939f833fbc5f501f47a375b1efbdfd1b915543a5d763ba15d2b54284c6"
},
"downloads": -1,
"filename": "bcdb-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "befffbc9ac2453917069d7d7dfbdf0cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 29330,
"upload_time": "2023-04-24T13:21:54",
"upload_time_iso_8601": "2023-04-24T13:21:54.287468Z",
"url": "https://files.pythonhosted.org/packages/3d/9d/130b234bc5bdaef469f48af51786de9420d98ab99e34aae923c62628a45b/bcdb-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-24 13:21:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "koviubi56",
"github_project": "bcdb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "bcdb"
}
JSON
