Skip to content

Commit 05cdbb1

Browse files
chekosclaude
chekos
and
claude
committed
Fix docs: site URL, emoji rendering, pip→uv, and code snippet errors
- Change site_url and all docs links from chekos.github.io/pypums to pypums.readthedocs.io - Add pymdownx.emoji extension to mkdocs.yml so :octicons-*: icons render - Replace all pip install references with uv add across docs and README - Remove pip/uv tabbed sections (just show uv) - Add Documentation URL to pyproject.toml - Fix multi-year.md: get_acs() state param only accepts str, not list - Fix spatial.md: parameter name n → dots_per_value in troubleshooting - Fix pums-microdata.md: pums_variables() → pypums.datasets.pums_variables() - Fix population-estimates.md: add missing AGEGROUP codes 13-17,30; expand abbreviated RACE labels to match source code - Add .claude/launch.json for mkdocs dev server Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent bb34d5f commit 05cdbb1

16 files changed

Lines changed: 68 additions & 70 deletions

‎.claude/launch.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"version": "0.0.1",
3+
"configurations": [
4+
{
5+
"name": "mkdocs",
6+
"runtimeExecutable": "uv",
7+
"runtimeArgs": ["run", "mkdocs", "serve"],
8+
"port": 8000
9+
}
10+
]
11+
}

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ Before submitting your code please do the following steps:
3434

3535
You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. You can also share your best practices with us.
3636

37-
See the full [contributing guide](https://chekos.github.io/pypums/about/contributing/) for more details.
37+
See the full [contributing guide](https://pypums.readthedocs.io/about/contributing/) for more details.

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ pums.head()
6666
## Installation
6767

6868
```bash
69-
pip install pypums
69+
uv add pypums
7070
```
7171

7272
For spatial/mapping support:
7373

7474
```bash
75-
pip install "pypums[spatial]"
75+
uv add "pypums[spatial]"
7676
```
7777

7878
## Census API Key
@@ -92,7 +92,7 @@ pypums.census_api_key("your-key-here")
9292

9393
## Documentation
9494

95-
Full documentation: [https://chekos.github.io/pypums](https://chekos.github.io/pypums)
95+
Full documentation: [https://pypums.readthedocs.io](https://pypums.readthedocs.io)
9696

9797
## Development
9898

‎docs/getting-started/installation.md‎

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,9 @@
77

88
## Install PyPUMS
99

10-
=== "pip"
11-
12-
```bash
13-
pip install pypums
14-
```
15-
16-
=== "uv"
17-
18-
```bash
19-
uv add pypums
20-
```
10+
```bash
11+
uv add pypums
12+
```
2113

2214
This installs PyPUMS and its core dependencies:
2315

@@ -34,17 +26,9 @@ This installs PyPUMS and its core dependencies:
3426

3527
If you plan to work with shapefiles, choropleths, or any geometry (the `geometry=True` parameter), install the spatial extras:
3628

37-
=== "pip"
38-
39-
```bash
40-
pip install "pypums[spatial]"
41-
```
42-
43-
=== "uv"
44-
45-
```bash
46-
uv add "pypums[spatial]"
47-
```
29+
```bash
30+
uv add "pypums[spatial]"
31+
```
4832

4933
This adds [`geopandas`](https://geopandas.org/) and its dependencies (`shapely`, `pyproj`, `fiona`), which enable PyPUMS to fetch TIGER/Line shapefiles and return `GeoDataFrame` objects.
5034

@@ -163,13 +147,13 @@ If this prints your key without raising an error, you are ready to go.
163147
running. Check with:
164148

165149
```bash
166-
pip show pypums
150+
uv pip show pypums
167151
```
168152

169153
If nothing is printed, install it again:
170154

171155
```bash
172-
pip install pypums
156+
uv add pypums
173157
```
174158

175159
??? question "I get `ValueError: No Census API key found`"
@@ -186,7 +170,7 @@ If this prints your key without raising an error, you are ready to go.
186170
You need the spatial extras. Install them with:
187171

188172
```bash
189-
pip install "pypums[spatial]"
173+
uv add "pypums[spatial]"
190174
```
191175

192176
## Next steps

‎docs/getting-started/quickstart.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ print(ca_income.head())
5959

6060
## 2. Make a map -- Tract-level choropleth
6161

62-
Fetch tract-level poverty rates for Los Angeles County and plot a choropleth. This requires the `spatial` extras (`pip install "pypums[spatial]"`).
62+
Fetch tract-level poverty rates for Los Angeles County and plot a choropleth. This requires the `spatial` extras (`uv add "pypums[spatial]"`).
6363

6464
```python
6565
import pypums

‎docs/guides/acs-data.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ ca_counties_geo.plot(column="estimate", legend=True)
388388

389389
!!! note "Optional dependency"
390390
`geometry=True` requires `geopandas`. Install it with
391-
`pip install pypums[spatial]` or `pip install geopandas`.
391+
`uv add "pypums[spatial]"`.
392392

393393
---
394394

@@ -614,7 +614,7 @@ See the [Finding Variables](variables.md) guide for full details.
614614
**`ImportError: geopandas`**
615615

616616
: Geometry support requires the spatial extras. Install them with
617-
`pip install "pypums[spatial]"`.
617+
`uv add "pypums[spatial]"`.
618618

619619
**`moe_level must be one of [90, 95, 99]`**
620620

‎docs/guides/decennial-data.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ county_geo.plot(column="value", legend=True)
230230

231231
!!! note "Optional dependency"
232232
`geometry=True` requires `geopandas`. Install with
233-
`pip install pypums[spatial]` or `pip install geopandas`.
233+
`uv add "pypums[spatial]"`.
234234

235235
---
236236

‎docs/guides/migration-flows.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ ca_flows_geo.plot(column="estimate", legend=True)
223223
The `geometry=True` option requires `geopandas` to be installed:
224224

225225
```shell
226-
pip install pypums[spatial]
226+
uv add "pypums[spatial]"
227227
```
228228

229229
## Caching

‎docs/guides/multi-year.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,17 @@ years = range(2018, 2023)
5151
frames = []
5252

5353
for year in years:
54-
df = pypums.get_acs(
55-
geography="state",
56-
variables="B01001_001",
57-
state=states,
58-
year=year,
59-
survey="acs5",
60-
cache_table=True, # cache to avoid re-fetching
61-
)
62-
df["year"] = year
63-
frames.append(df)
54+
for st in states:
55+
df = pypums.get_acs(
56+
geography="state",
57+
variables="B01001_001",
58+
state=st,
59+
year=year,
60+
survey="acs5",
61+
cache_table=True, # cache to avoid re-fetching
62+
)
63+
df["year"] = year
64+
frames.append(df)
6465

6566
trend = pd.concat(frames, ignore_index=True)
6667

‎docs/guides/population-estimates.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,14 @@ print(labeled[["NAME", "AGEGROUP", "AGEGROUP_label", "SEX", "SEX_label"]].head()
198198
| 10 | Age 18 to 64 years |
199199
| 11 | Age 18 years and over |
200200
| 12 | Age 65 years and over |
201+
| 13 | Under 18 years |
202+
| 14 | 5 to 13 years |
203+
| 15 | 14 to 17 years |
204+
| 16 | 18 to 64 years |
205+
| 17 | 16 years and over |
201206
| 18 | Under 5 years |
202207
| 29 | Age 0 to 14 years |
208+
| 30 | Age 15 to 44 years |
203209
| 31 | Age 16 years and over |
204210

205211
=== "SEX"
@@ -223,9 +229,9 @@ print(labeled[["NAME", "AGEGROUP", "AGEGROUP_label", "SEX", "SEX_label"]].head()
223229
| 6 | Two or more races |
224230
| 7 | White alone or in combination |
225231
| 8 | Black alone or in combination |
226-
| 9 | AIAN alone or in combination |
232+
| 9 | American Indian and Alaska Native alone or in combination |
227233
| 10 | Asian alone or in combination |
228-
| 11 | NHPI alone or in combination |
234+
| 11 | Native Hawaiian and Other Pacific Islander alone or in combination |
229235

230236
=== "HISP"
231237

@@ -393,7 +399,7 @@ pop_geo.plot(column="value", legend=True, cmap="Blues")
393399

394400
!!! note "Optional dependency"
395401
`geometry=True` requires `geopandas`. Install with
396-
`pip install pypums[spatial]` or `pip install geopandas`.
402+
`uv add "pypums[spatial]"`.
397403

398404
---
399405

0 commit comments

Comments
 (0)