https://github.com/codenameyau/studysheet
Automated study sheets
https://github.com/codenameyau/studysheet
Last synced: 11 months ago
JSON representation
Automated study sheets
- Host: GitHub
- URL: https://github.com/codenameyau/studysheet
- Owner: codenameyau
- License: gpl-2.0
- Created: 2014-04-05T04:27:06.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-04-13T16:58:38.000Z (about 12 years ago)
- Last Synced: 2025-03-24T15:12:06.641Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 353 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
studysheet
==========
StudySheet is a python script that takes a list of concepts or questions,
and creates a word document or PDF studysheet with a summary paragraph
taken from Wikipedia or an answer from computed from WolframAlpha.
## API Keys
To use the WolframAlpha module, you must sign up for an
API key at [here](http://products.wolframalpha.com/api/).
Then edit `knowledge/apikeys.py` and set `WOLFRAM` to your API key.
## Milestone Tasks
* [Done] Design modular project skeleton
* [Done] Integrate with WikiMedia API
* [Done] Generate word documents
* Integrate with WolframAlpha API
* Improve formatting and robustness
* Generate pdf documents
* Add image support
* Add configration options
* Improve pdf layout and design
### Future Projects
* Create Restful Flask API
* Create Angular web app or iOS mobile app
## Documentation Guidelines
Use [mini-docs](https://github.com/codenameyau/mini-docs) for function docstrings.