Update repo with template files

NASA-PDS / web-analytics

Other

0 stars 0 forks source link

Update repo with template files #33

Open kaipak opened 3 months ago

kaipak commented 3 months ago

💡 Description

Repo is missing some key elements. This work creates basic and functional versions of the following:

README.md. Include basic information to install, run, and troubleshoot.
requirements.txt
Documentation
Remove notebooks
Basic testing framework

⚔️ Parent Epic / Related Tickets

No response

jordanpadams commented 3 months ago

@kaipak see https://github.com/NASA-PDS/template-repo-python for a lot of the files you will need. Let me know if you need any help with what is what

jordanpadams commented 3 months ago

@kaipak Actually I lied, looks like I created this repo from that template :-) . But the README could use a scrub. For python, we use tox for testing and setup.cfg for python requirements

jordanpadams commented 3 months ago

Those are necessary in order for CICD pipeline to work...

kaipak commented 3 months ago

Ok, sounds good. I'll adhere to template as best I can. Will reach out if anything is confusing or unclear.

kaipak commented 3 months ago

@kaipak and @c-suh have discussed need for some more in-depth documentation for sync script. TBD, where this documentation will live, either internal Wiki or this repo's readme.