| Name | varsync JSON |
| Version |
1.16
JSON |
| download |
| home_page | https://github.com/Sriharan-S/varsync |
| Summary | A Python package for managing variables with a MySQL backend. |
| upload_time | 2024-08-18 12:56:57 |
| maintainer | None |
| docs_url | None |
| author | Sriharan |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# VarSYNC
**VarSYNC** is a Python package for managing user-specific variables with a web interface. It allows users to create, read, update, and delete variables and provides a straightforward API for accessing these variables in Python.
## Features
- **User Registration & Authentication**: Register and log in users.
- **Variable Management**: Create, read, update, and delete user-specific variables.
## Installation
You can install `varsync` from PyPI using pip:
```bash
pip install varsync
```
## Usage
### Register a New User
```python
import varsync
# Register a new user
varsync.register(username="your_username", password="your_password", confirm_password="your_password")
```
### Login
```python
import varsync
# Log in
session = varsync.login(username="your_username", password="your_password")
```
### Variable Management
**Get Variable**
```python
# Get a variable value
value = session.get("variable_name")
print(value) # Output: value or "Variable not set"
```
**Create Variable**
```python
# Create a new variable
session.create("variable_name", "variable_value")
```
**Edit Variable**
```python
# Edit an existing variable
session.edit("variable_name", "new_value")
```
**Delete Variable**
```python
# Delete a variable
session.delete("variable_name")
```
**List All Variables**
```python
# List all variables
variables = session.list()
print(variables)
```
## Contact
For any questions or support, please contact [sriharan2544@gmail.com](mailto:sriharan2544@gmail.com).
### Notes:
- `Features`: Lists key features of your package.
- `Installation`: Shows how to install the package.
- `Usage`: Provides examples of how to use the package.
- `Configuration`: Instructions to set up database credentials.
- `Contributing`: Guidelines for contributing to the project.
- `License`: Information about the project license.
- `Contact`: Your contact information for support or questions.
Raw data
{
"_id": null,
"home_page": "https://github.com/Sriharan-S/varsync",
"name": "varsync",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Sriharan",
"author_email": "sriharan2544@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/50/43/f260ed904b3ae95b0cefc39c3c32995eb229ac2d652c435c36ac0cbb18ec/varsync-1.16.tar.gz",
"platform": null,
"description": "# VarSYNC\r\n\r\n**VarSYNC** is a Python package for managing user-specific variables with a web interface. It allows users to create, read, update, and delete variables and provides a straightforward API for accessing these variables in Python.\r\n\r\n## Features\r\n\r\n- **User Registration & Authentication**: Register and log in users.\r\n- **Variable Management**: Create, read, update, and delete user-specific variables.\r\n\r\n## Installation\r\n\r\nYou can install `varsync` from PyPI using pip:\r\n\r\n```bash\r\npip install varsync\r\n```\r\n\r\n## Usage\r\n\r\n### Register a New User\r\n\r\n```python\r\nimport varsync\r\n\r\n# Register a new user\r\nvarsync.register(username=\"your_username\", password=\"your_password\", confirm_password=\"your_password\")\r\n```\r\n\r\n### Login\r\n\r\n```python\r\nimport varsync\r\n\r\n# Log in\r\nsession = varsync.login(username=\"your_username\", password=\"your_password\")\r\n```\r\n\r\n### Variable Management\r\n\r\n**Get Variable**\r\n\r\n```python\r\n# Get a variable value\r\nvalue = session.get(\"variable_name\")\r\nprint(value) # Output: value or \"Variable not set\"\r\n```\r\n\r\n**Create Variable**\r\n\r\n```python\r\n# Create a new variable\r\nsession.create(\"variable_name\", \"variable_value\")\r\n```\r\n\r\n**Edit Variable**\r\n\r\n```python\r\n# Edit an existing variable\r\nsession.edit(\"variable_name\", \"new_value\")\r\n```\r\n\r\n**Delete Variable**\r\n\r\n```python\r\n# Delete a variable\r\nsession.delete(\"variable_name\")\r\n```\r\n\r\n**List All Variables**\r\n\r\n```python\r\n# List all variables\r\nvariables = session.list()\r\nprint(variables)\r\n```\r\n\r\n## Contact\r\n\r\nFor any questions or support, please contact [sriharan2544@gmail.com](mailto:sriharan2544@gmail.com).\r\n\r\n### Notes:\r\n\r\n- `Features`: Lists key features of your package.\r\n- `Installation`: Shows how to install the package.\r\n- `Usage`: Provides examples of how to use the package.\r\n- `Configuration`: Instructions to set up database credentials.\r\n- `Contributing`: Guidelines for contributing to the project.\r\n- `License`: Information about the project license.\r\n- `Contact`: Your contact information for support or questions.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python package for managing variables with a MySQL backend.",
"version": "1.16",
"project_urls": {
"Homepage": "https://github.com/Sriharan-S/varsync"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d0d0daaf19a582b45c4ac300bbfa358e23cd888f1d270f6584648585361423a",
"md5": "d87e1fe8c059820fcdd1b9e99404d6c7",
"sha256": "3595a076f48c2f6ecfcccdfc074d605e89e252223a27aea1d0f520b58a85a9df"
},
"downloads": -1,
"filename": "varsync-1.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d87e1fe8c059820fcdd1b9e99404d6c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3933,
"upload_time": "2024-08-18T12:56:54",
"upload_time_iso_8601": "2024-08-18T12:56:54.252087Z",
"url": "https://files.pythonhosted.org/packages/9d/0d/0daaf19a582b45c4ac300bbfa358e23cd888f1d270f6584648585361423a/varsync-1.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5043f260ed904b3ae95b0cefc39c3c32995eb229ac2d652c435c36ac0cbb18ec",
"md5": "0dd41b6b3b64108ead76c6bac42ff234",
"sha256": "65378cea36a8c1029ec412d7a7e1698023bbb1399a815c48e285ad9f9d1feb86"
},
"downloads": -1,
"filename": "varsync-1.16.tar.gz",
"has_sig": false,
"md5_digest": "0dd41b6b3b64108ead76c6bac42ff234",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3375,
"upload_time": "2024-08-18T12:56:57",
"upload_time_iso_8601": "2024-08-18T12:56:57.122274Z",
"url": "https://files.pythonhosted.org/packages/50/43/f260ed904b3ae95b0cefc39c3c32995eb229ac2d652c435c36ac0cbb18ec/varsync-1.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 12:56:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Sriharan-S",
"github_project": "varsync",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "varsync"
}