Metadata-Version: 2.1
Name: archivy
Version: 1.0.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
Description: ![logo](docs/img/logo.png)
        
        
        # Archivy
        
        Archivy is a self-hosted knowledge repository that allows you to safely preserve useful content that contributes to your own personal, searchable and extensible wiki.
        
        Features:
        
        - If you add bookmarks, their web-pages 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
        - Notes are stored in an extended markdown format with footnotes, LaTeX math rendering, syntax highlighting and more. 
        - CLI that provides a nice backend interface to the app
        - [Git integration](https://github.com/archivy/archivy-git)
        - 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
        
        
        [demo video](https://www.uzpg.me/assets/images/archivy.mov)
        
        [Roadmap](https://github.com/archivy/archivy/issues/74#issuecomment-764828063)
        
        Upcoming:
        
        - Links / tagging between different knowledge base items
        - Image Upload
        - Annotations
        - Multi User System with permission setup.
        
        ## Quickstart
        
        
        Install archivy with `pip install archivy`. Other installations methods are listed [here](https://archivy.github.io/install), including Docker.
        
        Run the `archivy init` command to setup you installation.
        
        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.
        
        ## Community
        
        Archivy is dedicated at building **open and quality knowledge base software** through collaboration and community discussion.
        
        You can interact with us through the [issue board](https://github.com/archivy/archivy/issues) and the more casual [discord server](https://discord.gg/uQsqyxB).
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
