Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add programatic access and documentation #48

Open
versae opened this issue Oct 1, 2020 · 0 comments
Open

Add programatic access and documentation #48

versae opened this issue Oct 1, 2020 · 0 comments

Comments

@versae
Copy link
Collaborator

versae commented Oct 1, 2020

In some cases, like when running Averell as part of a bigger Python program, it would be very useful to be able to invoke the commands using a programmatic API. There might be one in place but it needs to be documented and as clean as possible. Something like an Averell class (class Averell) with a few methods:

averell = Averell(corpora_folder="...")
averell.corpora()  # list is a Python keyword
averell.download("adso")
averell.export("es", filename="es.json")
adso = averell.export("adso", raw=True)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant