-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CICO-6] Added toml for PyPi preparation, updated README, fixed add_i…
…tem endpoint
- Loading branch information
Showing
3 changed files
with
77 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,10 @@ | ||
## Citesphere Connector | ||
|
||
Python library to connect to Citephere using its [API](https://documenter.getpostman.com/view/19365454/UVeMJiyx). | ||
Python library to connect to Citephere using its [API](https://documenter.getpostman.com/view/19365454/UVeMJiyx). | ||
|
||
|
||
## 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` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
[project] | ||
name = "citesphere-connector" | ||
version = "1.0.0" | ||
dependencies = [ | ||
"cfgv", | ||
"distlib", | ||
"filelock", | ||
"identify", | ||
"nodeenv", | ||
"platformdirs", | ||
"pre_commit", | ||
"PyYAML", | ||
"ruff", | ||
"virtualenv", | ||
] | ||
requires-python = ">= 3.9" | ||
authors = [ | ||
{name = "Julia Damerow", email = "[email protected]"}, | ||
{name = "Julian Ophals", email = "[email protected]"}, | ||
{name = "Vishnu Vardhan Sanikommu", email = "[email protected]"}, | ||
{name = "Ajay Yadav", email = "[email protected]"}, | ||
] | ||
maintainers = [ | ||
{name = "Julia Damerow", email = "[email protected]"}, | ||
{name = "Julian Ophals", email = "[email protected]"}, | ||
] | ||
description = "Connect to Citesphere, an application that enables superior management of Zotero citations" | ||
readme = "README.md" | ||
license = {file = "LICENSE"} | ||
keywords = ["cite", "diging", "citesphere", "sphere", "zotero"] | ||
classifiers = [ | ||
"Development Status :: 4 - Beta", | ||
"Intended Audience :: Research Software Engineers, Researchers, Data Scientists, Developers", | ||
"Topic :: Reserach Software Engineering :: Citation Manager", | ||
"Programming Language :: Python", | ||
] | ||
|
||
[project.urls] | ||
"Citesphere API" = "https://documenter.getpostman.com/view/19365454/UVeMJiyx" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters