Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dandelionmood/mastodon2memos
A Python script that listens to your Mastodon posts & captures them in your Memos instance.
https://github.com/dandelionmood/mastodon2memos
mastodon mastodon-client memos pip python usememos
Last synced: about 21 hours ago
JSON representation
A Python script that listens to your Mastodon posts & captures them in your Memos instance.
- Host: GitHub
- URL: https://github.com/dandelionmood/mastodon2memos
- Owner: dandelionmood
- License: mit
- Created: 2025-01-05T15:01:24.000Z (22 days ago)
- Default Branch: main
- Last Pushed: 2025-01-25T19:46:30.000Z (1 day ago)
- Last Synced: 2025-01-25T20:25:22.125Z (1 day ago)
- Topics: mastodon, mastodon-client, memos, pip, python, usememos
- Language: Python
- Homepage:
- Size: 1.41 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mastodon2Memos
A Python script that reads your "public" Mastodon toots & captures them in a Memos instance as "public" memos.
Memos is a privacy-first, lightweight note-taking solution that allows you to effortlessly capture and share your ideas. See [Memos](https://www.usememos.com/) for more.
## Installation
1. Clone the repository:
```sh
git clone https://github.com/dandelionmood/mastodon2memos.git
cd mastodon2memos
```
2. Create a virtual environment:
```sh
python3 -m venv venv
source venv/bin/activate
```
3. Install the dependencies:
```sh
pip install -r requirements.txt
```
## Configuration
Copy the example configuration file to the expected location:
```sh
cp config.yaml.dist config.yaml
```
### Mastodon settings
Update the `mastodon` section in the `config.yaml` file with information from your Mastodon instance.
Set the `api_url` to the instance URL (e.g., "https://mastodon.social").
Create a Mastodon application in the Development section of your instance account to obtain the necessary values for the `client_id`, `client_secret`, and `access_token` keys. You can opt to only grant "read" access, which should be sufficient.
Set the `username` configuration key to the username on the instance from which you want to scrape content. Note: The script expects this account to be on the same instance server.
### Memos settings
Update the `memos` section in the `config.yaml` file with information from your Memos instance.
Set the `api_url` to the root URL of your Memos instance (e.g., "https://mymemos.test.org").
Generate an access token from the settings of the target account. Go to the "My Account" section, add a new access token, and copy its value to the `access_token` key in the configuration file. It is recommended to set the token to never expire to prevent the script from breaking in the future.
## Usage
### Is everything alright?
Ensure that the connection to both the Mastodon and Memos instances can be properly established using the troubleshoot command.
To run the command, execute the following:
```sh
python cli.py troubleshoot
```
This will check the status of the connections and let you know if something is not set up properly.
### Mastodon2Memos
If the troubleshoot command is successful, you can move on to using the `mastodon2memos` command.
**Important notes:**
- The script currently takes the last 30 toots and tries to import them. Anything older than that will be ignored.
- Memos converted from toots keep a reference to the original toot URL, which is used to ensure that no toot is added twice. No update is performed, so if you really want a toot to be updated, delete the related memo and run the script again.
#### Interactive mode
To test the waters, you might want to run the script in `--interactive` mode first.
This will ask before attempting to add toots as memos and let you review changes at each step.
This can be called using the `--interactive` option:
```sh
python cli.py mastodon2memos --interactive
```
#### Production mode
When everything is OK, you can finally start the script in non-interactive mode.
This can be achieved using the command:
```sh
python cli.py mastodon2memos
```
### Automating with Crontab
You can set up the script in your crontab to run it regularly. Open your crontab file with the following command:
```sh
crontab -e
```
Add the following line to schedule its execution:
```sh
*/15 * * * * cd /home/user/src/mastodon2memos && . venv/bin/activate && python cli.py mastodon2memos >> /tmp/mastodon2memos.log 2>&1
```
This will run the `mastodon2memos` script every 15 minutes and log execution details to the `/tmp/mastodon2memos.log` file with a standard out redirection. Feel free to remove the `>>` redirection if you don't need full execution logs.
**Note: the path to the script needs to be updated with the location of the project source code.**
## Development
Install the testing dependencies:
```sh
pip install -r requirements-tests.txt
```
Set up a distinct configuration dedicated to the unit tests:
```sh
cp config.yaml.dist config_test.yaml
```
**Note: Unit tests for this project do not use mock objects.** Instead, it is expected that you set up test instances or accounts on both Mastodon and Memos. This ensures that the tests interact with real data and APIs, providing more accurate and reliable results.
The test suite can then be run with `unittest`:
```sh
python -m unittest discover
```
## Contributing
Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.
1. Fork the repository.
2. Create a new branch for your feature or bugfix:
```sh
git checkout -b my-feature-branch
```
3. Make your changes.
4. Commit your changes:
```sh
git commit -m "Description of my changes"
```
5. Push to the branch:
```sh
git push origin my-feature-branch
```
6. Open a pull request on GitHub.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.