Rename folders to be PEP compatible
This commit is contained in:
37
ReadMe.md
37
ReadMe.md
@@ -9,6 +9,38 @@ This is a pip package that can be installed into any project and covers the foll
|
||||
- dump outputs for data
|
||||
- progress printing
|
||||
|
||||
## How to publish
|
||||
|
||||
Have the following setup in `project.toml`
|
||||
|
||||
```toml
|
||||
[[tool.uv.index]]
|
||||
name = "egra-gitea"
|
||||
url = "https://git.egplusww.jp/api/packages/PyPI/pypi/simple/"
|
||||
publish-url = "https://git.egplusww.jp/api/packages/PyPI/pypi"
|
||||
explicit = true
|
||||
```
|
||||
|
||||
```sh
|
||||
uv publish --index egra-gitea --token <gitea token> --native-tls
|
||||
```
|
||||
|
||||
## Test package
|
||||
|
||||
We must set the full index URL here because we run with "--no-project2
|
||||
|
||||
```sh
|
||||
uv run --with corelibs-python --index egra-gitea=https://git.egplusww.jp/api/packages/PyPI/pypi/simple/ --no-project --native-tls -- python -c "import CoreLibs"
|
||||
```
|
||||
|
||||
## How to install in another project
|
||||
|
||||
This will also add the index entry
|
||||
|
||||
```sh
|
||||
uv add corelibs-python --index egra-gitea=https://git.egplusww.jp/api/packages/PyPI/pypi/simple/ --native-tls
|
||||
```
|
||||
|
||||
## Python venv setup
|
||||
|
||||
In the folder where the script will be located
|
||||
@@ -17,3 +49,8 @@ In the folder where the script will be located
|
||||
uv venv --python 3.13
|
||||
```
|
||||
|
||||
Install all neded dependencies
|
||||
|
||||
```sh
|
||||
uv sync
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# MARK: Project info
|
||||
[project]
|
||||
name = "corelibs-python"
|
||||
version = "0.1.0"
|
||||
version = "0.2.0"
|
||||
description = "Collection of utils for Python scripts"
|
||||
readme = "ReadMe.md"
|
||||
requires-python = ">=3.13"
|
||||
@@ -15,7 +15,7 @@ dependencies = [
|
||||
# MARK: build target
|
||||
[[tool.uv.index]]
|
||||
name = "egra-gitea"
|
||||
url = "https://git.egplusww.jp/org/PyPI/dashboard"
|
||||
url = "https://git.egplusww.jp/api/packages/PyPI/pypi/simple/"
|
||||
publish-url = "https://git.egplusww.jp/api/packages/PyPI/pypi"
|
||||
explicit = true
|
||||
|
||||
|
||||
Reference in New Issue
Block a user