mkazin / aws-sg-mngr Goto Github PK

The project has been imported to ReadTheDocs.io, but there's only boilerplate under the /docs/ folder.
A documentation badge will appear on README.md soon.

Your task: transfer the text available in README.md over to the documentation, and expand as appropriate.

(Note: Automatic building of the actual API documentation is a separate task.)

See the ones in #1

More possiblities here:
https://github.com/kennethreitz/requests/blob/master/README.rst

Start with a simple Sqlite database implementation. Why?

• This server is assumed to on a non-shared instance behind the firewall. It can use a local database file without authentication.
• No need to support concurrency, consistency (i.e. transactions) for current expected use cases.
• Minimal footprint

Steps:

• Convert current DB to a schema
• Part of the setup process should instantiate a DB with the schema (Q: do we test for sqlite being installed as a requirement?)

Currently, only CIDRs are implemented in the API.
AWS allows for other security groups to appear as well.
This project should support that.

Additional features will likely result from this in client, server, storage...

• Review API design for completeness, accuracy
• Integrate auto-generation of Swagger documentation
• Deploy documentation to a public API site (Mashape?) (Q: can/should this be automatically done as part of the build process in Travis?)

https://github.com/codeclimate/javascript-test-reporter