A no-frills parser for the Federal Procurement Data System (FPDS) at https://www.fpds.gov/fpdsng_cms/index.php/en/.
The only programmatic access to this data via an ATOM feed limits each
request to 10 records, which forces users to deal with pagination.
Additonally, data is exported as XML, which proves annoying for most
developers. fpds
will handle all pagination and data
transformation to provide users with a nice JSON representation of the
equivalent XML data.
To install this package for development, create a virtual environment and install dependencies.
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -e .
For a list of valid search criteria parameters, consult FPDS documentation
found at: https://www.fpds.gov/wiki/index.php/Atom_Feed_Usage. Parameters
will follow the URL String
format shown in the link above, with the
following exceptions:
- Colons (:) will be replaced by equal signs (=)
- Certain parameters enclose their value in quotations.
fpds
will 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"
.
Via CLI:
$ fpds parse "LAST_MOD_DATE=[2022/01/01, 2022/05/01]" "AGENCY_CODE=7504"
By default, data will be dumped into an .fpds
folder at the user's
$HOME
directory. If you wish to override this behavior, provide the -o
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}
Same request via python interpreter:
from fpds import fpdsRequest
request = fpdsRequest(
target_database_url_env_key="SOME_ENVIRONMENT_VAR",
LAST_MOD_DATE="[2022/01/01, 2022/05/01]",
AGENCY_CODE="7504"
)
# handles automatic conversion of XML --> JSON
data = request()
# or conversely, you can call the explicit `process_records` method
data = request.process_records()
# URL magic method for assitance / debugging
url = request.__url__()
For linting and formatting, we use flake8
and black
.
$ make lint
$ make formatters
Lastly, you can clean the clutter and unwanted noise.
$ make clean
$ make test
fpds
now supports asynchronous requests! As of v1.3.0
, users can instantiate
the class as usual, but will now need to call the process_records
method
to get records as JSON. Note: due to some recursive function calls in the XML
parsing, users might experience some high completion times for this function
call. Recommendation is to limit the number of results.
v1.2.1 | v.1.3.0 |
---|---|
188.46 | 29.40 |
190.38 | 28.14 |
187.20 | 27.66 |
Using v.1.2.1
, the average completion time is 188.68 seconds (~3min).
Using v.1.3.0
, the average completion time is 28.40 seconds.
This equates to a 84.89% decrease in completion time!
As of v1.3.0
, fpds
now supports the use of over 100 keyword tags when searching
for contracts using the v1.5.3
ATOM feed.