Metadata-Version: 2.1
Name: archivy
Version: 0.9.1
Summary: Minimalist knowledge base focused on digital preservation and building your second brain.
Home-page: https://github.com/Uzay-G/archivy
Author: Uzay-G
Author-email: uzgirit@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: Flask (==1.1.2)
Requires-Dist: Flask-WTF (==0.14.3)
Requires-Dist: WTForms (==2.3.1)
Requires-Dist: Werkzeug (==1.0.1)
Requires-Dist: appdirs (==1.4.4)
Requires-Dist: attrs (==20.2.0)
Requires-Dist: beautifulsoup4 (>=4.8.2)
Requires-Dist: elasticsearch (==7.7.1)
Requires-Dist: pypandoc (==1.5)
Requires-Dist: python-dotenv (==0.13.0)
Requires-Dist: python-frontmatter (==0.5.0)
Requires-Dist: requests (==2.24.0)
Requires-Dist: tinydb (==4.1.1)
Requires-Dist: validators (==0.15.0)
Requires-Dist: watchdog (==0.10.3)
Requires-Dist: flask-login (==0.5.0)
Requires-Dist: click-plugins


![logo](docs/img/logo.png)

Logo design by [Roy Quilor](https://www.quilor.com/) is licensed under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0)

# Archivy

Archivy is a self-hosted knowledge repository that allows you to safely preserve useful content that contributes to your knowledge bank.

Features:

- If you add bookmarks, their webpages contents' will be saved to ensure that you will **always** have access to it, following the idea of [digital preservation](https://jeffhuang.com/designed_to_last/).
- Login module that allows you to host the service on a server
- Plugin system to allow people to publish and write extensions to archivy
- CLI that provides a nice backend interface to the app
- Backend API for flexibility and user enhancements
- Everything is a file! For ease of access and editing, all the content is stored in markdown files with yaml front matter.
- Extensible search with Elasticsearch and its Query DSL
- Dark Theme


![demo (low res)](https://github.com/Uzay-G/archivy/raw/master/archivy.gif)


Upcoming:

- Links between different knowledge base items
- Multi User System.
- Option to compile data to a static site.

## Quickstart

Begin by installing [Pandoc](https://pandoc.org), the document converter archivy uses.

Install with `pip install archivy`.

Then run this and enter a password to create a new user:

```bash
$ archivy create-admin <username>
```

Finally, execute `archivy run` to serve the app. You can open it at https://localhost:5000 and login with the credentials you entered before.

You can then use archivy to create notes, bookmarks and then organize and store information.

See the [official docs](https://archivy.github.io) for information on other installation methods.


