Time Capsule is a powerful tool designed to continuously capture and store your digital activities, creating a comprehensive digital memory. It provides a core system for data management with a web interface for interaction and optional plugins for various data capture methods.
For a detailed list of planned features, please see our TODO list.
Clone the repository:
git clone https://github.com/TheSethRose/Time-Capsule.git
cd Time-Capsule
Create and activate a virtual environment:
python -m venv .venv
source .venv/bin/activate # On Windows, use `.venv\Scripts\activate`
Install the required dependencies:
pip install -r requirements.txt
Configure settings in config.json
according to your preferences.
Start the Time Capsule application:
python main.py
The application will start and display the URL for accessing the web interface. Use this interface to manage plugins and control the Time Capsule.
Press Ctrl+C
in the terminal to initiate a graceful shutdown of the application.
Time Capsule uses a plugin system for extensibility. Plugins are located in the plugins
directory. Each plugin should be in its own subdirectory and contain a main class that matches the plugin name.
To create a new plugin:
plugins
folder with your plugin name.start()
and stop()
methods.Plugins can be enabled or disabled through the web interface or by modifying the config.json
file.
The config.json
file contains various settings for the application, including:
Modify this file to customize the behavior of Time Capsule.
Contributions are welcome! Please feel free to submit a Pull Request.
git checkout -b feature/AmazingFeature
)git commit -m 'Add some AmazingFeature'
)git push origin feature/AmazingFeature
)This project is licensed under the MIT License - see the LICENSE file for details.
For any questions, suggestions, or feedback, please feel free to reach out to me on X at @TheSethRose
Ensure compliance with all applicable laws and regulations when using this software, particularly regarding privacy and data protection. Time Capsule captures and stores personal data, so use it responsibly and with proper consent.