Skip to content

Commit

Permalink
Add a getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
clairernovotny committed Aug 9, 2024
1 parent 615f848 commit f8ca27c
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions python/StatsLogParser/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
A package for identifying nuget clients from user agents


### Local setup
To setup your local environment, you'll need Python 3.10 or later installed machine-wide, [pipx](https://pipx.pypa.io/stable/), and [Poetry](https://python-poetry.org/) (installed with pipx).

On Windows, [Scoop](https://scoop.sh/) is the easiest way to install Python. Install

Install pipx as per the [instructions](https://pipx.pypa.io/latest/installation/). On Windows, Scoop is the easiest way to install Python and pipx. Once you have pipx, you can use it to install poetry.


### Activating your python environment
In your CLI, go to the `python/StatsLogParser` directory and then run `poetry install` to create the virtual environment and install dependencies into it.

### Dev and Test
VS Code is recommended -- open the `python/StatsLogParser` folder and ensure you have the Python extensions installed. Poetry extensions are recommended too for environment activation. Testing is with pytest.

### Building the wheel
Run poetry build from the CLI and it'll build the wheel package in `dist`.

0 comments on commit f8ca27c

Please sign in to comment.