Skip to content

Commit c722fde

Browse files
update readme, increment package version (#46)
1 parent f4b9c91 commit c722fde

2 files changed

Lines changed: 12 additions & 10 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ pip install fgdb-to-gpkg
2424

2525
1. Clone the repository: `git clone https://github.com/philiporlando/fgdb_to_gdb.git`
2626
2. Navigate to the repository directory: `cd fgdb_to_gdb`
27-
3. Install the package and its dependencies with [poetry](https://python-poetry.org/): `poetry install`
27+
3. Install the package and its dependencies with [uv](https://astral.sh/uv):
28+
```bash
29+
uv sync --extra dev
30+
```
2831
4. Optionally, install the package to be run globally with pipx: `pipx install --editable .`
2932

3033
## Usage
@@ -69,34 +72,33 @@ help(fgdb_to_gpkg)
6972
Unit tests can be performed by the developers of this package using the following command:
7073

7174
```bash
72-
poetry run pytest tests
75+
uv run pytest
7376
```
7477

7578
Test coverage can be assessed using the following command:
7679

7780
```bash
78-
poetry run pytest --cov=fgdb_to_gpkg --cov-report term-missing
81+
uv run pytest --cov=fgdb_to_gpkg --cov-report term-missing
7982
```
8083

8184
#### Handling the Fiona GDAL compilation error
8285

8386
The unit tests within this package depend on `gdal=^3.6.0`, but the current version of `fiona` ships with `gdal=3.5.3`. The fiona package must be installed using the `--no-binary` flag to test this package. If this is not configured properly, then you will see the following error:
8487

8588
```bash
86-
poetry run pytest tests
89+
uv run tests
8790
# fiona.errors.DriverError: OpenFileGDB driver requires at least GDAL 3.6.0 for mode 'w', Fiona was compiled against: 3.5.3
8891
```
8992

90-
The `poetry.toml` file should contain all of the config needed to tell poetry how to handle this issue. However, if `poetry install` does not resolve the issue, then try the following:
93+
If you encounter errors related to GDAL or Fiona compatibility, ensure you have the correct versions installed and that your environment is synced using `uv`. If you still encounter issues, try reinstalling Fiona with:
9194

9295
```bash
93-
poetry run pip install --force-reinstall fiona --no-binary fiona
96+
uv pip install --force-reinstall fiona --no-binary fiona
9497
```
9598

9699
## Publishing
97100

98101
This package is automatically published to PyPI when a new release is crafted. For a successful publication, maintainers should:
99102

100-
1. Increment the version number in the pyproject.toml file. Ensure you update it in both the [project] and [project.dependencies] sections.
101-
102-
2. Adhere to `vX.X.X` the naming convention for the release name and tag.
103+
1. Increment the version number in the `pyproject.toml` file.
104+
2. Adhere to the `vX.X.X` naming convention for the release name and tag.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "fgdb-to-gpkg"
3-
version = "0.3.2"
3+
version = "0.4.0"
44
description = "A lightweight Python package that converts Esri File GeoDataBases into OGC GeoPackages"
55
authors = [
66
{ name = "Philip Orlando", email = "phlp.orlando@gmail.com" },

0 commit comments

Comments
 (0)