added readme #8
added readme #8
Conversation
There was a problem hiding this comment.
Looks good. The general stuff we want to include here (as opposed to documentation) is installation instructions, dependencies, (potentially) a contributing/feedback guide, FAQs, useful links to related repos. I think mostly you've got it covered!
We should also include stuff like test coverage, but probably not yet
README.md
Outdated
| 3) Update the url to "https://psweb.mp.qub.ac.uk/sne/atlas4/api/" | ||
|
|
||
| #### How do I get a token? | ||
| For now you ask Ken. One day we'll have an automated loging system. |
There was a problem hiding this comment.
This isn't strictly true, there is an endpoint for requesting a token for an account using username and password (the token refreshing endpoint), which we should add methods to utilise soon - either this week or for the next release. I'll add this as an issue!
README.md
Outdated
| Note: Here we don't parse the config file because we __assume you have named yours `api_config_MINE.yaml`__. | ||
| The path to that file is encoded in the `API_CONFIG_FILE` variable in the `atlasapiclient/utils.py` file and parsed by default to the classes. | ||
|
|
||
| If you feel fancy and want to name your config file differently you have to keep track of it's location and parse it with the argument `api_config_file`. |
There was a problem hiding this comment.
api_config_file doesn't necessarily mean a lot when not looking at the function definition, could just say "pass it as a string as the first argument".
Documentation of the API reference would be good for this reason, which is pretty easy with Sphinx
This should start to address Issue #5 and #6
Feedback on what might be edited or added would be useful. so we can put something on pypi that doesn't look half baked.