https://github.com/gridhead/fuas
AutoMAGICally gather and update the statistics of active users in Fedora Project over the course of last given period of time
https://github.com/gridhead/fuas
Last synced: 5 months ago
JSON representation
AutoMAGICally gather and update the statistics of active users in Fedora Project over the course of last given period of time
- Host: GitHub
- URL: https://github.com/gridhead/fuas
- Owner: gridhead
- License: gpl-3.0
- Created: 2023-02-28T05:07:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-15T03:08:38.000Z (over 1 year ago)
- Last Synced: 2025-07-04T17:09:07.448Z (12 months ago)
- Language: Dockerfile
- Homepage:
- Size: 6.7 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fuas
or Fedora User Activity Statistics
AutoMAGICally gather and update the statistics of active users in Fedora Project over the course of last given period of time
## Usage
### Superficially
> This might not work sometimes due to the time limit for each job present for GitHub Actions.
> The task for fetching a list of available usernames from FASJSON takes around 2 hours of time while
> the task for fetching a list of active usernames from Datagrepper takes over 6 hours of time.
1. Install `curl` on your Fedora Linux installation, if not installed already.
```
sudo dnf install curl
```
2. Obtain a list of available usernames by executing the following command.
```
curl https://raw.githubusercontent.com/t0xic0der/fuas/main/data/namefile -o /var/tmp/namefile
```
3. Obtain a list of active usernames by executing the following command.
```
curl https://raw.githubusercontent.com/t0xic0der/fuas/main/data/actvfile -o /var/tmp/actvfile
```
4. Obtain the number of active usernames by executing the following command.
```
echo "$(curl https://raw.githubusercontent.com/t0xic0der/fuas/main/data/acqtfile) usernames active"
```
### Actively
1. Install `cronie` and `podman` on your Fedora Linux installation, if not installed already.
```
$ sudo dnf install cronie podman
```
2. Clone the repository to your local storage and make it your present working directory.
```
$ git clone https://github.com/t0xic0der/fuas.git
$ cd fuas
```
3. Navigate into the [`cron`](https://github.com/t0xic0der/fuas/blob/main/cron/actv-push.Dockerfile) subdirectory and find a set of dockerfiles and shell scripts.
```
$ cd cron
```
[`actv-push.Dockerfile`](https://github.com/t0xic0der/fuas/blob/main/cron/actv-push.Dockerfile) - For generating a record of active usernames and pushing them to a Git repository
[`actv-only.Dockerfile`](https://github.com/t0xic0der/fuas/blob/main/cron/actv-only.Dockerfile) - For generating a record of active usernames only
[`name-push.Dockerfile`](https://github.com/t0xic0der/fuas/blob/main/cron/name-push.Dockerfile) - For generating a record of available usernames and pushing them to a Git repository
[`name-only.Dockerfile`](https://github.com/t0xic0der/fuas/blob/main/cron/name-only.Dockerfile) - For generating a record of available usernames only
4. Make necessary changes to the shell scripts with the same names as their dockerfiles of your choice.
5. Schedule building of these container images by adding an entry to the cron.
```
crontab -e
```
Please note that we strongly recommend running these build processes no more than twice a day keeping in mind the
long-running and resource intensive nature of the requests made against the services like FASJSON and Datagrepper.
## Development
1. Install Python 3, Virtualenv, PIP and Poetry on your Fedora Linux installation.
```
$ sudo dnf install python3 python3-virtualenv python3-pip poetry
```
2. Clone the repository to your local storage and make it your present working directory.
```
$ git clone https://github.com/t0xic0der/fuas.git
$ cd fuas
```
3. Set up and activate a virtual environment within the directory of the cloned repository.
```
$ virtualenv venv
$ source venv/bin/activate
```
4. Check the validity of the project configuration and install the project dependencies from the lockfile.
```
$ (venv) poetry check
$ (venv) poetry install
```
5. Execute the following command to view the help message.
```
$ (venv) fuas --help
```
Output
```
Usage: fuas [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
activity Fetch a list of active usernames from Datagrepper
namelist Fetch a list of usernames on the Fedora Account System
```
6. Execute the following command to view the project version.
```
$ (venv) fuas --version
```
Output
```
fuas, version 0.1.0
```
7. Make necessary changes to the variables located in the `fuas/conf.py` file, following the instructions.
```
$ (venv) nano fuas/conf.py
```
8. Fetch and store the list of available usernames locally by executing the following command.
```
$ (venv) fuas namelist
```
As this command makes a long-running and resource intensive request to the FASJSON service, it is strongly
recommended to not run this command manually and instead rely on the automatically updated list in the project
repository.
9. Fetch and store the list and count of active usernames by executing the following command.
```
$ (venv) fuas activity
```
As this command makes a long-running and resource intensive request to the Datagrepper service, it is strongly
recommended to not run this command manually and instead rely on the automatically updated list and count in the
project repository.