Skip to content

Commit 412ef4c

Browse files
committed
docs: update project documentation with new features and improvements
1 parent b205c74 commit 412ef4c

File tree

2 files changed

+35
-17
lines changed

2 files changed

+35
-17
lines changed

README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# geocodio-python
1+
# geocodio
22

3-
A Python client for the Geocodio API.
3+
The official Python client for the Geocodio API.
44

55
Features
66
--------
@@ -16,7 +16,27 @@ Installation
1616

1717
Install via pip:
1818

19-
pip install geocodio-python
19+
pip install geocodio
20+
21+
Development Installation
22+
-----------------------
23+
24+
1. Clone the repository:
25+
```bash
26+
git clone https://github.com/funkatron/geocodio-python.git
27+
cd geocodio-python
28+
```
29+
30+
2. Create and activate a virtual environment:
31+
```bash
32+
python -m venv venv
33+
source venv/bin/activate # On Windows: venv\Scripts\activate
34+
```
35+
36+
3. Install development dependencies:
37+
```bash
38+
pip install -e ".[dev]"
39+
```
2040

2141
Usage
2242
-----
@@ -73,9 +93,4 @@ Issues: <https://github.com/funkatron/geocodio-python/issues>
7393
License
7494
-------
7595

76-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
77-
78-
Authors
79-
-------
80-
81-
- Your Name <[email protected]>
96+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

pyproject.toml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ requires = ["hatchling"]
33
build-backend = "hatchling.build"
44

55
[project]
6-
name = "geocodio-python"
6+
name = "geocodio"
77
version = "0.1.0"
88
description = "A Python client for the Geocodio API"
99
readme = "README.md"
@@ -17,21 +17,24 @@ classifiers = [
1717
"Intended Audience :: Developers",
1818
"License :: OSI Approved :: MIT License",
1919
"Programming Language :: Python :: 3",
20-
"Programming Language :: Python :: 3.8",
21-
"Programming Language :: Python :: 3.9",
22-
"Programming Language :: Python :: 3.10",
2320
"Programming Language :: Python :: 3.11",
21+
"Programming Language :: Python :: 3.12",
22+
"Programming Language :: Python :: 3.13",
23+
"Programming Language :: Python :: 3.14",
24+
"Topic :: Software Development :: Libraries :: Python Modules",
25+
"Topic :: Internet :: WWW/HTTP :: Dynamic Content",
26+
"Topic :: Scientific/Engineering :: GIS",
27+
"Framework :: HTTP Client",
2428
]
2529
dependencies = [
2630
"httpx>=0.24.0",
2731
]
2832

2933
[project.urls]
30-
# TODO fix urls
3134
Homepage = "https://geocod.io"
32-
Documentation = "https://geocodio-python.readthedocs.io"
33-
Repository = "https://github.com/funkatron/geocodio-python"
34-
Issues = "https://github.com/funkatron/geocodio-python/issues"
35+
Documentation = "https://geocodio.readthedocs.io"
36+
Repository = "https://github.com/geocodio/geocodio-library-python"
37+
Issues = "https://github.com/geocodio/geocodio-library-python/issues"
3538

3639
[tool.hatch.build.targets.wheel]
3740
packages = ["src/geocodio"]

0 commit comments

Comments
 (0)