40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
# CFP Resume Loader
|
|
|
|
## What is it
|
|
Currently, just a collection of logic to pull/scrape relevant data
|
|
from various sources and storing CSV files with the desired data.
|
|
|
|
## Setup
|
|
On a Mac/Linux machine with a default python version >= 3.9,
|
|
just run `./setup.sh` and you should get
|
|
a poetry env with the relevant requirements installed.
|
|
|
|
On a Windows machine, you should be able to achieve the same thing
|
|
via WSLv2.
|
|
For instructions on installing WSL, [see here](https://docs.microsoft.com/en-us/windows/wsl/install).
|
|
To run a WSL terminal once installed,
|
|
you should be able to open Windows Terminal and enter `wsl`.
|
|
(Modern Windows usage is not this author's forte, so YMMV)
|
|
|
|
|
|
## Running
|
|
Once your setup is established,
|
|
you can call the script via `poetry run cfpresume`.
|
|
For details on options, add a `--help` flag at the end of that command.
|
|
By default, it will run all import sources and create a csv file for each.
|
|
|
|
|
|
## Development
|
|
Code is formatted with [black](https://black.readthedocs.io/en/stable/),
|
|
linted with [flake8](https://flake8.pycqa.org/en/latest/),
|
|
and type-checked with [mypy](https://mypy.readthedocs.io/en/stable/).
|
|
|
|
|
|
## Future Plans
|
|
The immediate plan is to add more sources to this code,
|
|
and extend the logic to load them in parallel rather than sequentially.
|
|
After that work is complete,
|
|
the next goal is to integrate the source data into the processing logic,
|
|
either by inserting the data into a target Excel file tab,
|
|
or by integrating the final report preparation itself into this code logic.
|