/sypter

A simple front-end testing tool-set for Python

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Contributors Forks Stargazers Issues MIT License


Logo

SypteR

Sypter is a simple front-end testing tool-set for Python
Explore the docs »

View Demo[coming up] · Report Bug · Request Feature

About The Project

Our team was in need to find a straightforward HTML element testing framework for Python. Unfortunately we didn't find one, so we decided to create our own.

(back to top)

Built With

Python

This section should list any major frameworks/libraries used to bootstrap your project. (Leave any add-ons/plugins for the Acknowledgments section)

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • You need to have Python installed on your machine. Please check the supported versions in build section.

Installation

For Usage

You can use Pip to install the package from git with following command:

pip install git+https://github.com/temurchichua/sypter.git

For local development

  1. Clone the repo 
    git clone https://github.com/temurchichua/sypter.git
  2. Create the virtual environment inside the repository. You can use virtualenv or venv for this purpose. 
    python -m venv venv
  3. Activate the virtual environment 
    source venv/bin/activate
  4. Install the dependencies 
    pip install -r requirements.txt

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

To Be Added

  • Feature 1
    • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

Distributed under the GNU GPLv3 . See LICENSE for more information.

(back to top)

Contact

Temur Chichua - @TemurChichua - contact@temurchichua.me

Project Link: https://github.com/temurchichua/sypter

(back to top)

Acknowledgments

(back to top)