TOC github

# pyShelf | project:pyshelf

Version 0.7.0 GPLv3

pyShelf is an open source ebook server written in Python. It is designed with ease of use in mind.

## Branches

- Master is the most stable branch, but may be behind in features.
- Dev is the most active branch, this branch is a rolling release branch.
- --* are used for day to day development.

## Formats

pyShelf supports the following formats:

- epub
- mobi
- pdf

## Services

- Backend
  - Book Scraper
  - OPDS
- Filesystem-io
  - Book Attachment System
- Frontend
  - RESTAPI
  - Dependency Management
  - User Management
  - User Experience
  - Data Management

## TODO

- Book Scraping System #f7edafb1
- REST API #c7bc51c5
- Client #21cbc756

## Development

pyShelf takes advantage of the following tools:

pre-commit doxygen & VimWiki we also follow semver standards.

- Program Flow

Please note that I use task, vimwiki, & taskwiki to manage my projects. Due to this Task entries marked via `* [ ] task` are postfixed with hex color data. Anyone who knows how to fix that I'm all ears :).