Khalshim / whiteapp_python

White app to begin a python project

White App Python

Table of Contents

1. Introduction
   • Dependencies
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgements

Introduction

Brief introduction

Dependencies

Getting Started

Prerequisites

• At least python 3.11.0 is required.
• Installing pip is highly recommanded as it will facilitate installation steps

Installation

• With pip
  • Install package
• From repository
  • Clone the repo

      git clone <Repo>

  • Install

      pip install .

    If you want to install it in development mode

      pip install -e .

Usage

pytown_model is used by pytown_client and pytown_server

Architecture

Roadmap

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Mehdi Halitim - [e-mail]