Metadata-Version: 2.1
Name: archivy
Version: 0.6.2
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: # 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/).
        - 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
        - Allows you to sync up with Pocket to gather bookmarks from there too.
        
        
        ![demo (low res)](https://github.com/Uzay-G/archivy/raw/master/archivy.gif)
        
        Upcoming:
        
        - Integrations with HN, Reddit, and many more.
        - Login module
        - Add submodules for digital identity so archivy syncs to your hn upvoted posts, reddit saved, etc...
        - Option to compile data to a static site that can be deployed.
        - Dark theme
        - UI for grouping by tag and use NLP to automatically generate connections between posts
        
        ## Setup
        
        ### Local Setup
        
        - Make sure your system has Python and pip installed.
        - Install the python package with `pip install archivy`
        - There you go! You should be able to start the app by running `archivy` in your terminal.
        
        ### Configuration
        
        Archivy uses environment variables for its configuration:
        
        | Variable                | Default                     | Description                           |
        |-------------------------|-----------------------------|---------------------------------------|
        | `ARCHIVY_DATA_DIR`      | System-dependant, see below | Directory in which data will be saved |
        | `ARCHIVY_PORT`          | 5000                        | Port on which archivy will run        |
        | `ELASTICSEARCH_ENABLED` | 0                           | Enable Elasticsearch integration      |
        | `ELASTICSEARCH_URL`     | http://localhost:9200       | Url to the elasticsearch server       |
        
        
        `ARCHIVY_DATA_DIR` by default will be set by the
        [appdirs](https://pypi.org/project/appdirs/) python library:
        
        On Linux systems, it follows the [XDG
        specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html):
        `~/.local/share/archivy`
        
        
        ### With Docker
        
        See the `docker` branch for details on setting things up with docker.
        
        ### Setting up Search
        
        Archivy uses [ElasticSearch](https://www.elastic.co) to provide efficient full-text search.
        
        Instructions to install and run the service are provided [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html).
        
        
        Append these two lines to your [elasticsearch.yml config file](https://www.elastic.co/guide/en/elasticsearch/reference/current/settings.html):
        
        ```yaml
        http.cors.enabled: true
        http.cors.allow-origin: "http://localhost:5000"
        ```
        
        Run archivy like this:
        
        ```bash
        ELASTICSEARCH_ENABLED=1 archivy
        ```
        
        ## Usage
        
        The first time you run archivy, an admin user will automatically be created with a random password.
        These credentials will be printed to the log when you launch like this:
        
        ```
        [2020-10-10 10:48:27,764] INFO in __init__: Archivy has created an admin user as it did not exist.
                                    Username: 'admin', password: '5a512991c605ea51038ce2a0'
        ```
        
        Login with these credentials and then you can change your password/username by clicking the profile button on the top left.
        
        You can then use archivy to create notes, organize it and store information.
        
        ## Community and Development
        
        If you're interested in developing and improving Archivy, please join our [community discord server](https://discord.gg/uQsqyxB).
        
        Feel free to [open issues](https://github.com/Uzay-G/archivy/issues/new) if you encounter bugs, have any ideas / feature requests and use the discord server for more casual discussion.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
