selene

(โ˜… 733)

User-oriented Web UI browser tests in Python

  • .codecov.yml
  • .coveragerc
  • .gitignore
  • .pylint-disabled-rules
  • CHANGELOG.md
  • CONTRIBUTING.md
  • LICENSE
  • mkdocs.yml
  • poetry.lock
  • pyproject.toml
  • README.md

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/yashaka/selene

Downloads the entire project code from GitHub to your computer.

cd selene

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install selene --pre

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install selene

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install git+https://github.com/yashaka/selene.git

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f tools/tinymce-local/Dockerfile -t selene .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 selene

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
poetry new my-tests-with-selene

Type this command into your terminal and run it.

poetry add selene --allow-prereleases # for pre-release version

Type this command into your terminal and run it.

poetry install

Installs the libraries listed in pyproject.toml.

pip install selene --pre

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install selene

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation