@@ -12,18 +12,15 @@ pip install buildingsync-asset-extractor
1212
1313### Install from source
1414
15- [ Poetry ] ( https://python-poetry.org / ) is required to install buildingsync-asset-extractor.
15+ [ uv ] ( https://docs.astral.sh/uv / ) is required to install buildingsync-asset-extractor.
1616
1717``` bash
1818# Copy repo
19- git clone https:// github.com/ BuildingSync/BuildingSync-asset-extractor.git
19+ git clone git@ github.com: BuildingSync/BuildingSync-asset-extractor.git
2020
2121# install the package
2222cd BuildingSync-asset-extractor
23- poetry install
24-
25- # Test that it works, you should see a message describing the usage
26- poetry run buildingsync_asset_extractor
23+ uv sync
2724```
2825
2926## Usage
@@ -60,7 +57,7 @@ asset will be named the same as the original asset, with ' Units' appended at th
6057To test usage:
6158
6259``` bash
63- python buildingsync_asset_extractor/main.py
60+ uv run buildingsync_asset_extractor/main.py
6461```
6562
6663This will extract assets from ` tests/files/testfile.xml ` and save the results to ` assets_output.json `
@@ -179,41 +176,36 @@ To enable pre-commit on every commit run the following from the command line fro
179176BuildingSync-asset-extractor
180177
181178``` bash
182- pre-commit install
179+ uv run pre-commit install
183180```
184181
185182To run pre-commit against the files without calling git commit, then run the following. This is useful when cleaning up
186183the repo before committing.
187184
188185``` bash
189- pre-commit run --all-files
186+ uv run pre-commit run --all-files
190187```
191188
192189### Testing
193190
194- poetry run pytest
191+ ``` bash
192+ uv run pytest -v
193+ ```
195194
196195## Releasing
197196
198197``` bash
199- poetry build
198+ uv build
200199
201- # config and push to testpypi
202- poetry config repositories.testpypi https://test.pypi.org/legacy/
203- poetry publish -r testpypi
200+ # push to testpypi
201+ uv publish --publish-url https://test.pypi.org/legacy/
204202
205203# install from testpypi
206204pip install --index-url https://test.pypi.org/simple/ buildingsync-asset-extractor
207205```
208206
209- If everything looks good, publish to pypi:
210-
211- ``` bash
212- poetry publish
213- ```
214-
215- If you have environment variables setup for PYPI token username and password:
207+ If everything looks good, publish to PyPI:
216208
217209``` bash
218- poetry publish --build --username $PYPI_USERNAME --password $PYPI_PASSWORD
210+ uv publish
219211```
0 commit comments