You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
50 lines
1.1 KiB
50 lines
1.1 KiB
# arango |
|
|
|
A simple Python wrapper for connecting to and interacting with ArangoDB. |
|
|
|
## Installation |
|
|
|
Install dependencies: |
|
|
|
```bash |
|
pip install -r requirements.txt |
|
``` |
|
|
|
You also need to install `env_manager` to help set up environment variables for ArangoDB: |
|
|
|
```bash |
|
pip install git+https://github.com/lasseedfast/env_manager.git |
|
``` |
|
|
|
## Usage |
|
|
|
Environment variables: |
|
|
|
- `ARANGO_HOST` |
|
- `ARANGO_DB` |
|
- `ARANGO_USERNAME` |
|
- `ARANGO_PWD` |
|
|
|
Tthe package will use `env_manager` to set them automatically (first time you may need to provide a password). |
|
|
|
Example: |
|
|
|
```python |
|
from _arango import arango |
|
|
|
results = arango.execute_aql("FOR doc IN my_collection RETURN doc") |
|
``` |
|
|
|
## Using as a Base for Your Own Project |
|
|
|
If you want to use this package as a starting point for your own ArangoDB utilities, you can clone the repository: |
|
|
|
```bash |
|
git clone https://git.edfast.se/lasse/arango.git |
|
``` |
|
|
|
You can then add your own methods and modify the code as needed. If you do not plan to sync changes back to the original repository, consider to remove or change the remote origin to avoid accidentally pushing changes to the original repo: |
|
```bash |
|
git remote remove origin |
|
``` |
|
|
|
|