diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 0000000..f38b1dd --- /dev/null +++ b/BUILD.md @@ -0,0 +1,21 @@ +# Build Instructions + +Run the following command to build the project: + +```shell +python -m build +``` + +This will create distribution files in the `dist/` directory. + +Install the built package using pip: + +```shell +pip install --no-index dist/docs_harvester-0.1.0-py3-none-any.whl +``` + +Install in editable mode for development: + +```shell +pip install -e . +``` diff --git a/DEVOPS.md b/DEVOPS.md new file mode 100644 index 0000000..4acb1cc --- /dev/null +++ b/DEVOPS.md @@ -0,0 +1,9 @@ +# DevOps Notes + +## DevOps OAuth2 Flow + +Type: **oauth2** +Flow: **accessCode** +Authorization URL: `https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion` +Token URL: `https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer` +Scopes: `vso.code` \ No newline at end of file diff --git a/README.md b/README.md index 6636ca4..1df7456 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,3 @@ [![Unit Tests](https://gitea.koszewscy.waw.pl/slawek/docs-harvester/actions/workflows/unit-tests.yml/badge.svg)](https://gitea.koszewscy.waw.pl/slawek/docs-harvester/actions?workflow=unit-tests.yml) This project is designed to harvest and process Markdown documentation files from Git repositories. - -## DevOps OAuth2 Flow - -Type: **oauth2** -Flow: **accessCode** -Authorization URL: `https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion` -Token URL: `https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer` -Scopes: `vso.code` \ No newline at end of file