Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Scobiform/fedi-follow-force-graph
Mastodon analytics tool that generates a force graph to visually represent the relationships between user followers and followings on Mastodon. Users can log in via Mastodon OAuth to view graphs of their social connections. The tool is coded primarily in Python and utilizes JavaScript libraries for graphical representations.
https://github.com/Scobiform/fedi-follow-force-graph
async dotenv force graph mastodon python quart ui web
Last synced: 3 months ago
JSON representation
Mastodon analytics tool that generates a force graph to visually represent the relationships between user followers and followings on Mastodon. Users can log in via Mastodon OAuth to view graphs of their social connections. The tool is coded primarily in Python and utilizes JavaScript libraries for graphical representations.
- Host: GitHub
- URL: https://github.com/Scobiform/fedi-follow-force-graph
- Owner: Scobiform
- License: agpl-3.0
- Created: 2024-04-17T11:56:19.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-04-26T14:24:55.000Z (9 months ago)
- Last Synced: 2024-10-15T07:21:14.183Z (4 months ago)
- Topics: async, dotenv, force, graph, mastodon, python, quart, ui, web
- Language: HTML
- Homepage:
- Size: 8.29 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Fedi follow force graph
[](https://github.com/Scobiform/fedi-follow-force-graph/actions/workflows/github-code-scanning/codeql)
Mastodon analytics tool that generates a force graph to visually represent the relationships between user followers and followings on Mastodon. Users can log in via Mastodon OAuth to view graphs of their social connections. The tool is coded primarily in Python and utilizes JavaScript libraries for graphical representations.
## Table of Contents
- [Requirements](#requirements)
- [Environment Setup](#environment-setup)
- [Create Virtual Environment](#create-virtual-environment)
- [Start the Application](#start-the-application)
- [Mastodon Developer Settings](#mastodon-developer-settings)
- [Contributions](#contributions)
- [Screenshots](#screenshots)
- [License](#license)
## Requirements
```plaintext
Python:
dotenv - BSD-3-Clause License
Mastodon.py - AGPL-3.0 License
Quart - MIT License
Quart-Auth - MIT License
JavaScript:
force-graph - MIT License
d3-quadtree - BSD-3-Clause License
d3-force - BSD-3-Clause License
element-resize-detector - MIT License
```
## Environment Setup
Create a `.env` file with the following content to configure the application:
```plaintext
APP_URL=https://yourdomain
REPO_PATH=/path/to/repo
```
## Create virtual environment
Create a virtual environment and install the requirements:
```plaintext
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
## Start the application
Run the application with the following command:
```plaintext
python3 start.py
```
## Mastdodon developer settings
You will need a valid callback address that is reachable from the internet. You can use a service like [ngrok](https://ngrok.com/) to create a tunnel to your local machine.
## Contributions
Contributions are welcome! Please submit a pull request or open an issue if you would like to contribute to the project.
## Screenshots
## License
AGPL-3.0
## Do not use this in production
This is a proof of concept and should not be used in production. The application has not been tested for security vulnerabilities.