```markdown
# TweakedDB
TweakedDB is a lightweight file-based database library for Python with 64-bit encryption. It provides a simple key-value store with basic CRUD operations.
```
## Installation
```bash
pip install tweaked
```
## Quick Start
```python
from tweaked import TweakedDB
# Initialize the database with a filename and a secret key
db = TweakedDB('mydatabase.tw', 'mysecretkey')
# Set values
db.set('name', 'John Doe')
db.set('age', '30')
# Get values
name = db.get('name')
print(f"Name: {name}")
# Delete a key
db.delete('age')
# Get all keys
all_keys = db.get_all_keys()
print(f"All Keys: {all_keys}")
```
## Methods
### `set(key, value)`
Sets the value for a given key in the database.
### `get(key)`
Retrieves the value for a given key from the database.
### `delete(key)`
Deletes a key-value pair from the database.
### `get_all_keys()`
Returns a list of all keys in the database.
## File Format
Data is stored in a text file with each key-value pair on a new line. Keys and values are separated by a colon.
## Encryption
TweakedDB uses 64-bit encryption to secure the data. The encryption key is derived from the secret key provided during initialization.
## Contributing
If you'd like to contribute to TweakedDB, please fork the repository, make your changes, and submit a pull request.
## Maintainers
TweakedDB is maintained by Cities and Sizzor. If you encounter any issues or have questions, you can contact them on Discord:
- Cities: `mlg0001` (Discord Tag)
- Sizzor: `.sizzor` (Discord Tag)
Updated project
Fixed some bugs due to alot of this issues that didn't work also made it so where u just have to do
```bash
pip install tweaked
```
## License
This project is licensed under the MIT License with an additional clause.
MIT License:
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.
**Additional Clause:** The software and its derivatives may not be used for commercial purposes or claimed as the original work of the user without explicit permission from the original author (you).
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.
```
Raw data
{
"_id": null,
"home_page": "",
"name": "tweaked",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,database,file-based,encryption,key-value store",
"author": "sizzor and cities",
"author_email": "tokyorevenge127@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e7/de/4da5ec069078ae0d138f0650feef46687c6192aea5f6fbea0f983e19c1cf/tweaked-1.1.2.tar.gz",
"platform": null,
"description": "```markdown\r\n# TweakedDB\r\n\r\nTweakedDB is a lightweight file-based database library for Python with 64-bit encryption. It provides a simple key-value store with basic CRUD operations.\r\n\r\n\r\n```\r\n\r\n## Installation\r\n\r\n```bash\r\npip install tweaked\r\n```\r\n\r\n## Quick Start\r\n\r\n```python\r\nfrom tweaked import TweakedDB\r\n\r\n# Initialize the database with a filename and a secret key\r\ndb = TweakedDB('mydatabase.tw', 'mysecretkey')\r\n\r\n# Set values\r\ndb.set('name', 'John Doe')\r\ndb.set('age', '30')\r\n\r\n# Get values\r\nname = db.get('name')\r\nprint(f\"Name: {name}\")\r\n\r\n# Delete a key\r\ndb.delete('age')\r\n\r\n# Get all keys\r\nall_keys = db.get_all_keys()\r\nprint(f\"All Keys: {all_keys}\")\r\n```\r\n\r\n## Methods\r\n\r\n### `set(key, value)`\r\n\r\nSets the value for a given key in the database.\r\n\r\n### `get(key)`\r\n\r\nRetrieves the value for a given key from the database.\r\n\r\n### `delete(key)`\r\n\r\nDeletes a key-value pair from the database.\r\n\r\n### `get_all_keys()`\r\n\r\nReturns a list of all keys in the database.\r\n\r\n## File Format\r\n\r\nData is stored in a text file with each key-value pair on a new line. Keys and values are separated by a colon.\r\n\r\n## Encryption\r\n\r\nTweakedDB uses 64-bit encryption to secure the data. The encryption key is derived from the secret key provided during initialization.\r\n\r\n## Contributing\r\n\r\nIf you'd like to contribute to TweakedDB, please fork the repository, make your changes, and submit a pull request.\r\n\r\n## Maintainers\r\n\r\nTweakedDB is maintained by Cities and Sizzor. If you encounter any issues or have questions, you can contact them on Discord:\r\n\r\n- Cities: `mlg0001` (Discord Tag)\r\n- Sizzor: `.sizzor` (Discord Tag)\r\n\r\nUpdated project\r\n\r\nFixed some bugs due to alot of this issues that didn't work also made it so where u just have to do \r\n\r\n```bash\r\npip install tweaked\r\n```\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License with an additional clause.\r\n\r\nMIT License:\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining a copy\r\nof this software and associated documentation files (the \"Software\"), to deal\r\nin the Software without restriction, including without limitation the rights\r\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r\ncopies of the Software, and to permit persons to whom the Software is\r\nfurnished to do so, subject to the following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included in all\r\ncopies or substantial portions of the Software.\r\n\r\n**Additional Clause:** The software and its derivatives may not be used for commercial purposes or claimed as the original work of the user without explicit permission from the original author (you).\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\nSOFTWARE.\r\n```\r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Lightweight file-based database library for Python with 64-bit encryption.",
"version": "1.1.2",
"project_urls": null,
"split_keywords": [
"python",
"database",
"file-based",
"encryption",
"key-value store"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e7de4da5ec069078ae0d138f0650feef46687c6192aea5f6fbea0f983e19c1cf",
"md5": "0b1cddd98c91951ee9c4eed817a83475",
"sha256": "8825d1eaeca1161ea04c0153978bfb3815f2fbf0926bd46eeb3d9301cf914dcd"
},
"downloads": -1,
"filename": "tweaked-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "0b1cddd98c91951ee9c4eed817a83475",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4091,
"upload_time": "2023-11-25T09:11:59",
"upload_time_iso_8601": "2023-11-25T09:11:59.698568Z",
"url": "https://files.pythonhosted.org/packages/e7/de/4da5ec069078ae0d138f0650feef46687c6192aea5f6fbea0f983e19c1cf/tweaked-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-25 09:11:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tweaked"
}
JSON