https://github.com/diging/citesphere-connector
Python library to connect to citesphere
https://github.com/diging/citesphere-connector
Last synced: 18 days ago
JSON representation
Python library to connect to citesphere
- Host: GitHub
- URL: https://github.com/diging/citesphere-connector
- Owner: diging
- License: mpl-2.0
- Created: 2022-09-02T20:28:01.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-13T23:34:15.000Z (over 1 year ago)
- Last Synced: 2025-03-14T00:28:34.029Z (over 1 year ago)
- Language: Jupyter Notebook
- Size: 170 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Citesphere Connector
Python library to connect to Citephere using its [API](https://documenter.getpostman.com/view/19365454/UVeMJiyx).
## PyPi Package Installation
`pip install citesphere-connector`
## Developer Setup
Create a python virtual environment outside of this project's root directory `python3 -m venv env` and activate it `source env/bin/activate`
Navigate to the project root and download package dependencies `pip install -r requirements.txt`
Install the pre-commit git hooks `pre-commit install`
For retrieivng the Bearer access token required for endpoint method calls, please see the following OAuth2 [documentation](https://diging.atlassian.net/wiki/spaces/OAC/pages/3533078792/Getting+OAuth2+Access+Token+in+Postman) for Citesphere
## User Guide
Retrieve Bearer access token required for endpoint method calls: [documentation](https://diging.atlassian.net/wiki/spaces/OAC/pages/3533078792/Getting+OAuth2+Access+Token+in+Postman)
### Downloading Files
Use the 'Download' Jupyter notebook to download files from Citesphere to your local device.
### Uploading File
Use the 'Upload' Jupyter notebook to upload files to Citesphere from your local device.