Skip to content

Commit

Permalink
Update README documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dherincx92 committed Aug 22, 2024
1 parent 62f4f5a commit 2aee37a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To install this package for development, create a virtual environment
and install dependencies.

```
$ python3.8 -m venv venv
$ python3.10 -m venv venv
$ source venv/bin/activate
$ pip install -e .
```
Expand All @@ -33,7 +33,7 @@ following exceptions:
automatically determine if quotes are needed, so simply enclose your
entire criteria string in quotes.

For example, `AGENCY_CODE:3600` should be used as `"AGENCY_CODE=3600"`.
For example, `AGENCY_CODE:"3600"` should be used as `"AGENCY_CODE=3600"`.

Via CLI:
```
Expand All @@ -45,7 +45,7 @@ By default, data will be dumped into an `.fpds` folder at the user's
option. The directory will be created if it doesn't exist:

```
$ fpds parse "LAST_MOD_DATE=[2022/01/01, 2022/05/01]" "AGENCY_CODE=7504" -o {some-directory}
$ fpds parse "LAST_MOD_DATE=[2022/01/01, 2022/05/01]" "AGENCY_CODE=7504" -o my-preferred-directory
```

Same request via python interpreter:
Expand Down Expand Up @@ -75,7 +75,7 @@ $ make clean

### Testing
```
$ make test
$ make local-test
```

## What's New
Expand Down
4 changes: 2 additions & 2 deletions src/fpds/core/parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
Base classes for FPDS XML elements.
author: [email protected]
last_updated: 07/13/2024
last_updated: 08/21/2024
"""

import asyncio
import multiprocessing
from asyncio import Semaphore
from concurrent.futures import ProcessPoolExecutor
from itertools import chain
from typing import Dict, List, Optional, Union
from typing import List, Optional, Union
from urllib import parse
from urllib.request import urlopen
from xml.etree.ElementTree import ElementTree, fromstring
Expand Down

0 comments on commit 2aee37a

Please sign in to comment.