Elemental

Elemental makes Selenium automation faster and easier.

Adds common use-cases

Common use-cases missing from Selenium are built into Elemental. Get an input by its label or placeholder? Can do. Get a button by its text or type? Sure. Get an element's parent? Yep. Get the fourth element in a list? No problem.

Automatic waiting

Elemental has built-in automatic waiting so that your automation is less flaky. It has a sensible default which can be overriden when necessary.

The full power of Selenium

For complex operations which require the full power of the Selenium, Elemental gives you easy access to 100% of Selenium's API.

Terse, clean API

Write less code than you would if you were using Selenium directly. The Elemental API is terse and internally consistent while still being explicit and unambiguous.

The power of Elemental

import elemental

# Set up.
browser = elemental.Browser()

# Search PyPI for Elemental.
browser.visit("https://www.pypi.org")
browser.get_input(placeholder="Search projects").fill("elemental")
browser.get_button(type="submit").click()

# Click the first search result.
browser.get_element(partial_text="elemental").click()

# Confirm that Elemental's PyPI page was found.
assert browser.title == "elemental · PyPI"

# Tear down.
browser.quit()

Installation

$ pip install elemental

Development

Get set up, preferably in a virtualenv:

$ make init
$ make install

Lint the code:

$ make lint

Run the tests:

$ make test

Build the docs:

$ cd docs
$ make html

Releasing

1. Check out the main branch.

2. Ensure CHANGELOG.rst includes everything to go in the release and is committed.

3. Ensure everything to go in the release is committed.

4. Increment the version in elemental/__init__.py and docs/source/conf.py.

5. Shift everything in the Unreleased section of CHANGELOG.rst to a new section named with the new version number and the current date.

6. Ensure CI runs without warnings or errors:

   $ make ci
   

7. Make and tag the release commit:

   $ make release
   

8. Build the package:

   $ make package
   

9. Publish the package to PyPI:

   $ make publish
   

10. Push to the repo and clean up packaging artifacts:

    $ make push
    $ make clean
    

11. Create a GitHub release.

Code style

1. Only modules are imported. Classes, functions and variables are not imported directly.
2. A module's functions are ordered alphabetically.
3. A module's private functions are placed alphabetically at the bottom of the module.
4. Docstrings follow the NumPy docstring guide.
5. Strings are enclosed with double quotes.
6. The last item of a multi-line dictionary or list has a trailing comma.

Changes

For what has changed in each version, see CHANGELOG.rst.