Data Science Template

Data Science Template is a template repository for data science projects.

Badges

Add badges from somewhere like: shields.io

Features

Light/dark mode toggle
Live previews
Fullscreen mode
Cross platform

Tech Stack

Client: React, Redux, TailwindCSS

Server: Node, Express

Demo

Insert gif or link to demo

Screenshots

Installation

Install my-project with pip

  pip install my-project
  cd my-project

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

API_KEY

ANOTHER_API_KEY

Deployment

To deploy this project run

  npm run deploy

Run Locally

Clone the project

  git clone https://link-to-project

Go to the project directory

  cd my-project

Install dependencies

  poetry install

Start the server

  flask run

Usage/Examples

from automata.fa.dfa import DFA

from visual_automata.fa.dfa import VisualDFA

dfa = VisualDFA(
    states={"q0", "q1", "q2", "q3", "q4"},
    input_symbols={"0", "1"},
    transitions={
        "q0": {"0": "q3", "1": "q1"},
        "q1": {"0": "q3", "1": "q2"},
        "q2": {"0": "q3", "1": "q2"},
        "q3": {"0": "q4", "1": "q1"},
        "q4": {"0": "q4", "1": "q1"},
    },
    initial_state="q0",
    final_states={"q2", "q4"},
)

Running Tests

To run tests, run the following command

  pytest -vs

API Reference

Get all items

  GET /api/items

Parameter	Type	Description
`api_key`	`string`	Required. Your API key

Get item

  GET /api/items/${id}

Parameter	Type	Description
`id`	`string`	Required. Id of item to fetch

add(num1, num2)

Takes two numbers and returns the sum.

Color Reference

Color	Hex
Example Color	#0a192f
Example Color	#f8f8f8
Example Color	#00b48a
Example Color	#00d1a0

Documentation

Appendix

Any additional information goes here

Optimizations

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

Roadmap

Additional browser support
Add more integrations

Here are some related projects

Awesome README

Lessons Learned

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

FAQ

Question 1

Answer 1

Question 2

Answer 2

Feedback

If you have any feedback, please reach out to us at fake@fake.com

Support

For support, email fake@fake.com or join our Slack channel.

Used By

This project is used by the following companies:

Company 1
Company 2

Authors

@lewiuberg

Acknowledgements

Data Science Simplified for all her amazing tips.
The realpython community for all their great feedback and help.
readme.so for helping in making amazing readme's.

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

License

MIT

lewiuberg / data_sience_template