Simple-AI

A brief description of what this project does and who it's for

Features

• WIP

Documentation

Documentation

Installation

Install simple-ai with pip

  pip install simple-ai

Run Locally

Clone the project

  git clone https://github.com/deadpyxel/simple-ai

Go to the project directory

  cd simple-ai

Install dependencies with pipenv

  pipenv install --dev

Start the dev server

  pipenv run pytest

Running Tests

To run tests, run the following command

  pipenv run pytest

Or, if you are using a non-pipenv managed env, first activate the virtual env, then just run

pytest

With this you should have the tests always running, monitoring for file changes and reporting coverage as terminal, XML and HTML reports.

Usage/Examples

import Component from 'my-project'

function App() {
  return <Component />
}

Optimizations

What optimizations did you make in your code? E.g. refactors, performance improvements, accessibility

Lessons Learned

What did you learn while building this project? What challenges did you face and how did you overcome them?

Acknowledgements

• Class lectures
• Pipenv
• Architecture Patterns with Python
• How to write a Good readme

License

MIT

Also on LICENSE file.

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

Authors

• @deadpyxel