Commit 11bfce68 authored by Krisjanis Rijnieks's avatar Krisjanis Rijnieks 🔥

Update README with P3 etc

parent f55eb698
Pipeline #143827 passed with stage
in 34 seconds
## Fab Academy - file sizes workflow script
# Fab Academy - file sizes workflow script
> NOTE: There is also a size checking script in gitlab-automation-2020 repo called project_file_sizes
#### Requisites
## Requirements
Install python2.7, pip
Use Python 3.7 and its corresponding pip version. Check versions like so.
```bash
python --version
# Should output Python 3.7.3 or similar
pip --version
# Should output pip 20.0.2 from /some/path/pip (python 3.7) or similar
```
Install Python dependencies.
```bash
pip install -r requirements.txt
```
Set the TOKEN env var:
Set the `TOKEN` environment variable.
```bash
export TOKEN="<your gitlab personal token>"
```
#### Usage
## Usage
generate the sizes.md file
Before running, change the year variable in `filesizes.py` and `upload_sizes.py` to the current year. Run the following to generate the `sizes.md` file.
```bash
python filesizes.py
```
# upload it to the staff project
Then upload it to the staff project using the `upload_sizes.py` script.
```bash
python upload_sizes.py
```
Will upload the `sizes.md` to https://gitlab.fabcloud.org/academany/fabacademy/2019/site
\ No newline at end of file
This will upload the `sizes.md` to https://gitlab.fabcloud.org/academany/fabacademy/{YEAR}/site
## TODO
- Change YEAR to an input parameter or environment variable so one does not have to change it in two places.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment