calpoly-csai / api

Official API for the NIMBUS Voice Assistant accessible via HTTP REST protocol.
https://nimbus.api.calpolycsai.com/
GNU General Public License v3.0
9 stars 4 forks source link

add Pipfile and Pipfile.lock for use with pipenv #89

Open mfekadu opened 4 years ago

mfekadu commented 4 years ago

csai-scraping uses pipenv and it is just simply intuitive.

Let's set that up here too

It should make issues like #82 less common and easier to resolve/communicate too

Changes needed

Here are 2 nice cheat sheets

Another guide

Pipfiles are toml files

mfekadu commented 4 years ago

My process for making the Pipfile

1. pipenv --python 3.6.8

2. pipenv shell

3. ./run.sh

...
ModuleNotFoundError: No module named 'FOOBAR_FIZZBUZZ'

4. pipenv install FOOBAR_FIZZBUZZ

5. repeat 3-4 until everything works

6. manually add package_name = "*" to the other nice-to-have packages

mfekadu commented 4 years ago

Problems

mfekadu commented 4 years ago

mostly done

https://github.com/calpoly-csai/api/blob/48336b06f95e3676c5322d6760c34968b2d145d5/Pipfile#L1-L66

https://github.com/calpoly-csai/api/blob/48336b06f95e3676c5322d6760c34968b2d145d5/Pipfile.lock#L1-L24

just need to update the readme to look like this