From f8ca27c0320913b20e404b7a966cc2efdee2405d Mon Sep 17 00:00:00 2001 From: Claire Novotny Date: Fri, 9 Aug 2024 12:07:50 -0400 Subject: [PATCH] Add a getting started --- python/StatsLogParser/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/python/StatsLogParser/README.md b/python/StatsLogParser/README.md index 32b3a17082..8c0a9cb729 100644 --- a/python/StatsLogParser/README.md +++ b/python/StatsLogParser/README.md @@ -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`.