Netbox/oxipy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update project repository URL and simplify installation instructions in README.md

Browse Source 
- Added a repository URL section in `pyproject.toml` to link to the GitHub repository.
- Updated installation instructions in `README.md` to reflect the change from Gitea to GitHub as the source for package installation, removing references to the private Gitea Package Registry.
This commit is contained in:
IluaAir
2026-05-29 15:53:24 +03:00
parent 2a03240414
commit 494cc9b08b
2 changed files with 10 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@@ -22,62 +22,30 @@ configuration sections such as system data, interfaces, and VLANs.
## Installation ## Installation
The package is distributed through a private Gitea Package Registry and from the The package is distributed from the source repository. It is not published to
source repository. It is not published to PyPI. PyPI yet.
**Requirements:** Python 3.10+ **Requirements:** Python 3.10+
### From Gitea Package Registry ### From GitHub Source
Install the package by pointing `pip` to the private registry:
```bash
pip install oxipy \
--index-url https://gitea.imbastark.ru/api/packages/Netbox/pypi/simple/
```
You can also configure the registry permanently in `pip.conf` or `pip.ini`:
```ini
# ~/.config/pip/pip.conf (Linux/macOS)
# %APPDATA%\pip\pip.ini (Windows)
[global]
extra-index-url = https://gitea.imbastark.ru/api/packages/Netbox/pypi/simple/
```
After that, install normally:
```bash
pip install oxipy
```
If the registry requires authentication, pass a token in the index URL:
```bash
pip install oxipy \
--index-url https://__token__:<your_token>@gitea.imbastark.ru/api/packages/Netbox/pypi/simple/
```
### From Gitea Source
Install directly from the repository: Install directly from the repository:
```bash ```bash
pip install git+https://gitea.imbastark.ru/Netbox/oxipy.git pip install git+https://github.com/sttarsky/oxipy.git
``` ```
Install a specific tag or branch: Install a specific tag or branch:
```bash ```bash
pip install git+https://gitea.imbastark.ru/Netbox/oxipy.git@v0.1.0 pip install git+https://github.com/sttarsky/oxipy.git@v0.1.0
pip install git+https://gitea.imbastark.ru/Netbox/oxipy.git@dev pip install git+https://github.com/sttarsky/oxipy.git@dev
``` ```
For local development: For local development:
```bash ```bash
git clone https://gitea.imbastark.ru/Netbox/oxipy git clone https://github.com/sttarsky/oxipy
cd oxipy cd oxipy
pip install -e . pip install -e .
``` ```

3
pyproject.toml
View File

@@ -20,6 +20,9 @@ dependencies = [
"ttp>=0.10.0", "ttp>=0.10.0",
] ]
[project.urls]
Repository = "https://github.com/sttarsky/oxipy"
[tool.setuptools.packages.find] [tool.setuptools.packages.find]
where = ["."] where = ["."]
include = ["oxi*"] include = ["oxi*"]