#23 Update the readme file
Merged 9 months ago by mattdm. Opened 9 months ago by josseline.
josseline/fedora-contributor-trends update_readme_get_started  into  main

file modified
+57 -4
@@ -12,8 +12,32 @@ 

  

  ----

  

- To get started, clone this repo and run `./run.sh`. You'll need the package

- `python-fedmsg` installed.

+ ### Get started

+ To get started you must have `python3` installed, after that, clone this repo and follow the instructions below:

+ 

+ * Create one virtual environment and activate it

+ 

+ Linux/MacOS

+ ```

+   python3 -m venv .venv

+   source .venv/bin/activate

+ ```

+ Windows

+ ```

+   python3 -m venv .venv

+   .venv/bin/activate.bat

+ ```

+ 

+ * Install the requirements of the project in the environment

+ 

+ ```

+   pip install -r requirements.txt

+ ```

+ 

+ * Run the project

+ ```

+   ./run.sh

+ ```

  

  Note that this will try to gather data going back to the beginning of the

  message bus, which is a long time and a lot of data, and it hits the service
@@ -37,7 +61,8 @@ 

  5. Find an official place for this to run rather than on mattdm's personal server.

  6. Simply put, the graphs and reports could be prettier.

  

- Any or all of these things would be an huge improvement.

+ Any or all of these things would be a huge improvement.

+ 

  

  ----

  
@@ -62,7 +87,35 @@ 

  

  One thing that's an explicit non-goal: anything that is easily tied to a specific individual in the results, except maybe for very high level totals.

  

- 

  ----

  

+ ### Contributions

+ Before you push any changes or improvements remember in order to follow the rules PEP8 you must run the style code tools

+ 

+ * Running `flake8`

+ 

+ all project

+ ```

+   flake8 .

+ ```

+ or a single file

+ 

+ ```

+   flake8 my_python_file.py

+ ```

+ **NOTE** you must resolve any errors that show `flake8`

+ 

+ 

+ * Running `black`

+ 

+ all project

+ ```

+   black .

+ ```

+ or a single file

+ 

+ ```

+   black my_python_file.py

+ ```

+ 

  More? See https://pagure.io/fedora-contributor-trends/issues! 

\ No newline at end of file

Resolves #22

Thie PR update the readme file, describing how to run the project and the how to run the style code tools

Hi, @mattdm could you review this PR please ? :smile:

Pull-Request has been merged by mattdm

9 months ago
Metadata