Skip to content

Commit

Permalink
Update readme w/ new CLI, bump version & python version requirements.
Browse files Browse the repository at this point in the history
  • Loading branch information
gaulinmp committed Jan 28, 2025
1 parent ab443f5 commit f833d82
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 14 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
nc_examples/
docs/
*.pyedgar.conf
*-checkpoint.ipynb


# Byte-compiled / optimized / DLL files
Expand Down
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,30 +150,36 @@ print(config.CONFIG_FILE)

## downloader

There is a convenience downloader script, for downloading filing feed files and indexes.
There is a convenience downloader CLI, for downloading filing feed files and indexes.

To see the status of current cached downloads (shows the latest downloaded files) and to see the config setup:

```bash
$ python -m pyedgar.downloader --status --config
$ python -m pyedgar --status --config
```

To download and extract index files:
This will download and extract the indices (you can use -s and -e to specify years/dates to download):

```bash
$ python -m pyedgar.downloader -i --log info
$ python -m pyedgar -i
```

And to download and extract the last 30 days of filings:
This will download and extract the last 30 days of forms:

```bash
$ python -m pyedgar.downloader -d
$ python -m pyedgar -d -x --last-n-days 30
```

To download and extract filings since the beginning:
This will only download the daily feed files in 1998:

```bash
$ python -m pyedgar.downloader -d --start-date 1995-01-01
$ python -m pyedgar -d -s 1998 -e 1999
```

This will only extract all daily feed files:

```bash
$ python -m pyedgar -x -s 1994
```


Expand Down
2 changes: 1 addition & 1 deletion pyedgar/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"""

__title__ = 'pyedgar'
__version__ = '0.1.12'
__version__ = '0.1.13'
__version_info__ = tuple(int(i) for i in __version__.split("."))
__author__ = 'Mac Gaulin'
__license__ = 'MIT'
Expand Down
10 changes: 5 additions & 5 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,12 @@
'License :: OSI Approved :: MIT License',

'Programming Language :: Python :: 3 :: Only',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3.11',
'Programming Language :: Python :: 3.12',
'Programming Language :: Python :: 3.13',
],
packages=find_packages(),
include_package_data=True,
Expand Down

0 comments on commit f833d82

Please sign in to comment.