Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scobiform/tootticker
Requesting account information via Mastodon API and saving it as pure JSON.
https://github.com/scobiform/tootticker
flask json listmanager mastodon metrics pyhton typescript
Last synced: 15 days ago
JSON representation
Requesting account information via Mastodon API and saving it as pure JSON.
- Host: GitHub
- URL: https://github.com/scobiform/tootticker
- Owner: Scobiform
- License: agpl-3.0
- Created: 2023-12-01T14:37:57.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-13T21:48:43.000Z (10 months ago)
- Last Synced: 2024-11-07T04:12:55.889Z (2 months ago)
- Topics: flask, json, listmanager, mastodon, metrics, pyhton, typescript
- Language: Python
- Homepage:
- Size: 313 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TootTicker
[](https://www.python.org/)
[](https://opensource.org/licenses/GPL-3.0)
> Requesting account information via Mastodon API and saving it as JSON.
## Table of Contents
- [Background](#background)
- [Install](#install)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Background
TootTicker is a Python script that fetches account information from provided Mastodon handles (@INSTANCE@USERNAME). The script utilizes the Mastodon API to retrieve details and saves this information in JSON files in the 'accounts' directory.
* It will also create a HTML overview with charts for each category
* Will follow all accounts in your config.json
* Will create all categories as lists in your Mastodon account and add accounts to it
## Install
# Clone the repository
```
git clone https://github.com/Scobiform/TootTicker.git
```
# Change into the project directory
```
cd TootTicker
```
# Install dependencies
```
pip install Mastodon.py
```
```
pip install flask
```
## Usage
**TootTicker** is currently under heavy development, and its features and commands are subject to change.
Run ``` python3 TootTicker.py ```
Open ``` localhost:5000 ``` in your browser
### Credits
Special thanks to the contributors from German media sites:
- Sebastian: [@pertsch.social@Sebastian](https://pertsch.social/@Sebastian)
- Mho: [@social.heise.de@mho](https://social.heise.de/@mho)
## Contributing
Contributions are welcome!
## License
**TootTicker** is licensed under the **GNU General Public License v3.0**.
### Libraries Used:
The following libraries are used in this project, each with its respective license:
- **Mastodon.py**: MIT License - [View License](https://github.com/halcy/Mastodon.py)
- **Chart.js**: MIT License - [View License](https://www.chartjs.org/)
- **Flask**: BSD License - [View License](https://flask.palletsprojects.com/en/2.0.x/)
- **Gunicorn**: Multiple Licenses (MIT and others) - [View License Details](https://github.com/benoitc/gunicorn?tab=License-1-ov-file#readme)
### Note:
Please ensure to adhere to the licensing terms of each library and tool used in your project.