Skip to content

Commit 403e78b

Browse files
authored
Added SBIR awards and solicitations functionality (#17)
1 parent 36ef727 commit 403e78b

18 files changed

+4601
-389
lines changed

README.md

Lines changed: 7 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -43,80 +43,17 @@ print(res)
4343

4444
## CLI Usage
4545

46-
# `fargo`
46+
Out of the box, there is a simple CLI, called `fargo`. You can use it to do things like:
4747

48-
**Usage**:
49-
50-
```console
51-
$ fargo [OPTIONS] COMMAND [ARGS]...
52-
```
53-
54-
**Options**:
55-
56-
- `--install-completion`: Install completion for the current shell.
57-
- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
58-
- `--help`: Show this message and exit.
59-
60-
**Commands**:
61-
62-
- `far`: Get a provision of the FAR
63-
- `sam`: Get a SAM entity's JSON data by providing...
64-
- `usaspending`: Get JSON data about an entity from...
65-
66-
## `fargo far`
67-
68-
Get a provision of the FAR
69-
70-
**Usage**:
71-
72-
```console
73-
$ fargo far [OPTIONS] SECTION_NUMBER
74-
```
75-
76-
**Arguments**:
77-
78-
- `SECTION_NUMBER`: [required]
79-
80-
**Options**:
81-
82-
- `--help`: Show this message and exit.
83-
84-
## `fargo sam`
85-
86-
Get a SAM entity's JSON data by providing a UEI
87-
88-
**Usage**:
89-
90-
```console
91-
$ fargo sam [OPTIONS] UEI
92-
```
93-
94-
**Arguments**:
95-
96-
- `UEI`: [required]
97-
98-
**Options**:
99-
100-
- `--help`: Show this message and exit.
101-
102-
## `fargo usaspending`
103-
104-
Get JSON data about an entity from USASpending by providing a UEI
105-
106-
**Usage**:
48+
```sh
49+
fargo sam [UEI]
50+
# Dumps a json of an entity's information
10751

108-
```console
109-
$ fargo usaspending [OPTIONS] UEI
52+
fargo usaspending [UEI] --awards
53+
# Dumps a json of an entity's 10 most recent awards (in the last 90 days)
11054
```
11155

112-
**Arguments**:
113-
114-
- `UEI`: [required]
115-
116-
**Options**:
117-
118-
- `--awards / --no-awards`: [default: no-awards]
119-
- `--help`: Show this message and exit.
56+
Check out [the docs](https://procurement-tools.readthedocs.io/en/latest/cli.html) for all of the CLI options
12057

12158
## Installation
12259

docs/CHANGELOG.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
CHANGELOG
22
=========
33

4+
0.1.6
5+
-----
6+
7+
New
8+
~~~
9+
- Access to the SBIR API with two methods (:code:`SBIR.get_awards` and :code:`SBIR.get_solicitations`), that allow for downloading SBIR awards and solicitations, respectively
10+
- Added new pydantic models related to SBIR
11+
412
0.1.5
513
-----
614

docs/entity.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,7 @@ Contents
4242
.. toctree::
4343
:maxdepth: 1
4444

45-
roadmap
4645
api
4746
cli
48-
entity
47+
models
4948
CHANGELOG

docs/models.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Models
2+
======
3+
4+
We use `Pydantic <https://docs.pydantic.dev/latest/>`_ for defining certain models in the library.
5+
6+
7+
SAM Entity
8+
~~~~~~~~~~
9+
10+
.. automodule:: procurement_tools.models.entity
11+
:members:
12+
13+
FAR Reps and Certs Answers
14+
~~~~~~~~~~~~~~~~~~~~~~~~~~
15+
16+
.. automodule:: procurement_tools.models.sam_entity.far_answer
17+
:members:
18+
19+
SBIR Solicitations
20+
~~~~~~~~~~~~~~~~~~
21+
22+
.. automodule:: procurement_tools.models.sbir
23+
:members:
24+

docs/roadmap.rst

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)