Added package build and develop instructions.
This commit is contained in:
21
BUILD.md
Normal file
21
BUILD.md
Normal file
@@ -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 .
|
||||||
|
```
|
||||||
9
DEVOPS.md
Normal file
9
DEVOPS.md
Normal file
@@ -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`
|
||||||
@@ -3,11 +3,3 @@
|
|||||||
[](https://gitea.koszewscy.waw.pl/slawek/docs-harvester/actions?workflow=unit-tests.yml)
|
[](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.
|
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`
|
|
||||||
Reference in New Issue
Block a user