Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/poiley/syllaborem

Syllabus Parser
https://github.com/poiley/syllaborem

Last synced: about 1 month ago
JSON representation

Syllabus Parser

Awesome Lists containing this project

README

        

# :open_book: Syllaborem
[![Django CI](https://github.com/poiley/syllaborem/actions/workflows/django.yml/badge.svg?branch=master)](https://github.com/poiley/syllaborem/actions/workflows/django.yml)

Syllaborem is a Django web app who's goal is to turn your Syllabus into something more pleasant.

## :inbox_tray: Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install dependencies.

```bash
pip install -r requirements.txt
```

## :hammer_and_wrench: Usage

Running the Web Server
```bash
python manage.py runserver
```

Compiling (?)
```bash
python manage.py makemigrations user
```

Reading PDF files:

```python
from apps import reader

r = reader.core.Reader()

print(r.read_file('Syllabus.pdf'))

```

## :pencil2: Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## :pushpin: License
[The Unlicence](https://unlicense.org/)