manen 0.3.0.dev1__tar.gz → 0.3.0.dev3__tar.gz

{manen-0.3.0.dev1 → manen-0.3.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: manen
-Version: 0.3.0.dev1
+Version: 0.3.0.dev3
 Summary: An implementation of the Page Object Model design pattern, and other utilities for web scraping and automation.
 Project-URL: Changes, https://kodaho.github.io/manen/changelog.html
 Project-URL: Documentation, https://kodaho.github.io/manen/
@@ -45,11 +45,13 @@ Description-Content-Type: text/markdown
 ---
 
 <p align="center">
-  <a href="https://pypi.org/project/manen">PyPI package</a>
+  <a href="https://pypi.org/project/manen">PyPI</a>
   ・
   <a href="https://kodaho.github.io/manen/">Documentation</a>
   ・
-  <a href="https://github.com/kodaho/manen/issues">Issue tracking</a>
+  <a href="https://kodaho.github.io/manen/changelog.html">Changelog</a>
+  ・
+  <a href="https://github.com/kodaho/manen/issues">Issue tracker</a>
 </p>
 
 Manen is a package built to enhance developer experience when using Selenium. Among the core
@@ -57,7 +59,7 @@ features, you can find:
 
 - an implementation of the [Page Object Model](https://www.selenium.dev/documentation/en/guidelines_and_recommendations/page_object_models/)
   design pattern
-- a class which improves the operability of a Selenium's Webdriver
+- a class which improves the operability of a Selenium's WebDriver
 - a function to easily find and isolate DOM elements inside a Selenium page
 
 This package aims to provide you the tools to write more concise, flexible and powerful code
@@ -190,8 +192,8 @@ print(page.results[0].model_dump())
 > [!TIP]
 > Other DOM elements are also implemented, such as `ImageSrc`, `Input`, `Checkbox`... Each one of
 > them is used to target a specific attribute from a DOM element and enable interaction with it,
-> in a flawless Pythonic way. Check the [documentation](https://kodaho.github.io/manen/) for the
-> full list of available elements.
+> in a flawless Pythonic way. Check the [documentation](https://kodaho.github.io/manen/user_guide/page_object_model.html#List-of-available-elements)
+> for the list of available elements.
 
 Let's finally close the Selenium WebDriver to avoid any remaining running applications once we
 exit the Python program.

{manen-0.3.0.dev1 → manen-0.3.0.dev3}/README.md

@@ -20,11 +20,13 @@
 ---
 
 <p align="center">
-  <a href="https://pypi.org/project/manen">PyPI package</a>
+  <a href="https://pypi.org/project/manen">PyPI</a>
   ・
   <a href="https://kodaho.github.io/manen/">Documentation</a>
   ・
-  <a href="https://github.com/kodaho/manen/issues">Issue tracking</a>
+  <a href="https://kodaho.github.io/manen/changelog.html">Changelog</a>
+  ・
+  <a href="https://github.com/kodaho/manen/issues">Issue tracker</a>
 </p>
 
 Manen is a package built to enhance developer experience when using Selenium. Among the core
@@ -32,7 +34,7 @@ features, you can find:
 
 - an implementation of the [Page Object Model](https://www.selenium.dev/documentation/en/guidelines_and_recommendations/page_object_models/)
   design pattern
-- a class which improves the operability of a Selenium's Webdriver
+- a class which improves the operability of a Selenium's WebDriver
 - a function to easily find and isolate DOM elements inside a Selenium page
 
 This package aims to provide you the tools to write more concise, flexible and powerful code
@@ -165,8 +167,8 @@ print(page.results[0].model_dump())
 > [!TIP]
 > Other DOM elements are also implemented, such as `ImageSrc`, `Input`, `Checkbox`... Each one of
 > them is used to target a specific attribute from a DOM element and enable interaction with it,
-> in a flawless Pythonic way. Check the [documentation](https://kodaho.github.io/manen/) for the
-> full list of available elements.
+> in a flawless Pythonic way. Check the [documentation](https://kodaho.github.io/manen/user_guide/page_object_model.html#List-of-available-elements)
+> for the list of available elements.
 
 Let's finally close the Selenium WebDriver to avoid any remaining running applications once we
 exit the Python program.

manen-0.3.0.dev3/docs/source/changelog.rst

@@ -0,0 +1,145 @@
+Changelog
+=========
+
+.. |topic| raw:: html
+
+  <span style="display: inline-block; width: 110px; font-size:85%; font-weight: 600;">Topic</span> <span style="font-size:85%">
+
+.. |released_on| raw:: html
+
+  <span style="display: inline-block; width: 110px; font-size:85%; font-weight: 600;">Release date</span> <span style="font-size:85%">
+
+.. |end| raw:: html
+
+  </span>
+
+
+0.3.0
+-----
+
+|topic| Page object model implementation revamp & other major changes |end|
+
+|released_on| (unreleased) |end|
+
+.. warning::
+
+  Even if it's a minor release, this version represents a major change for the project; the
+  package has been mostly rewritten in order to implement the page object model design pattern in
+  a more efficient way (using type annotation).
+
+  Besides, some functionalities have been removed with the aim of limiting the number of features
+  during the beta phase.
+
+  All previous versions should be considered as deprecated.
+
+
+Changed
+^^^^^^^
+- The module :py:mod:`~manen.page_object_model` has been rewritten to use type annotation instead
+  of ``Element``. Note that some elements like select or radio button haven't been implemented in
+  this new version yet (but will be in the future).
+- Most of the documentation pages have been rewritten and improved.
+- Most modules have better typing annotations and documentation. Besides, the code has been
+  improved to be more "Pythonic".
+- Manen no longer has optional dependencies (which were in fact development dependencies).
+- The minimal version of Python required is now 3.10.
+- Internally, Manen is now using `rye <https://rye.astral.sh/guide/>`_ as project manager, and
+  `ruff <https://docs.astral.sh/ruff/>`_ for the linting and formatting.
+
+Removed
+^^^^^^^
+- The module ``manen.resource`` and everything related (like the CLI) have been removed. Indeed,
+  the `official Selenium manager <https://www.selenium.dev/documentation/selenium_manager/>`_
+  (available as a CLI tool and in recent versions of Python bindings for Selenium) provides the
+  same functionalities.
+- ``manen.browser.BraveBrowser`` has been removed because it had a dependency on the module
+  ``manen.resource``. Besides, it was considered as not enough tested internally to make it
+  available publicly.
+
+|
+
+0.2.0
+-----
+
+|topic| Rename some classes in :py:mod:`~manen.page_object_model` and improve CLI |end|
+
+|released_on| 2022-02-19 |end|
+
+Added
+^^^^^
+- Specify link to changelog in documentation in package metadata.
+- Introduce new options in ``manen driver download`` to set the specifications of the drivers
+  to be downloaded directly from the command line.
+- Add exhaustibility in documentation of :py:mod:`~manen.page_object_model` to describe
+  private/special methods and classes other than the ones in ``__all__``.
+
+Changed
+^^^^^^^
+
+- Improve CLI command to download drivers executable (now launched with ``manen driver download``).
+- Rename :py:class:`~manen.page_object_model.DateTimeElement` (previously ``DatetimeElement``).
+- Rename :py:class:`~manen.page_object_model.DOMAccessor` (previously ``DomAccessor``).
+
+Fixed
+^^^^^
+- Fix link to notebooks in the info section of :ref:`User Guide`
+
+|
+
+0.1.2
+-----
+
+|topic|  Fix bug in the download workflow of the CLI |end|
+
+|released_on| 2022-02-19 |end|
+
+Fixed
+^^^^^
+
+- Fix a ``TypeError`` in the download workflow (variable wrongly named).
+
+|
+
+0.1.1
+-----
+
+|topic| Mainly documentation improvements |end|
+
+|released_on| 2022-02-12 |end|
+
+Changed
+^^^^^^^
+
+- Make documentation publicly available under
+  `kodaho.github.io/manen <https://kodaho.github.io/manen/>`_.
+- Complete README page.
+- Add the section `About the project` in the documentation (moved from home page).
+- Complete user guides.
+- Rewording and reformatting of several sections.
+
+|
+
+0.1.0
+-----
+
+|topic| First release of the package |end|
+
+|released_on| 2022-01-31 |end|
+
+Added
+^^^^^
+
+- :py:func:`~manen.finder.find` allows to easily get element(s) in a WebDriver
+  page. This function support several very different use cases, thanks to several
+  arguments that can be passed to the function.
+- :py:mod:`~manen.resource` is a module to easily interact with all the assets
+  needed by Selenium. It allows for example to download the drivers, executable
+  required to launch a WebDriver.
+- :py:mod:`~manen.browser` defined :py:class:`~manen.browser.ChromeBrowser`
+  and :py:class:`~manen.browser.BraveBrowser`, an enhanced Selenium WebDriver.
+- :py:mod:`~manen.page_object_model` is the implementation of `page object
+  model <https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/>`_
+  described in Selenium documentation. Thanks to that, you can describe and
+  interact with the DOM structure through Python classes.
+- A :py:mod:`~manen.cli` is shipped with the initial release in order to download
+  drivers files.

{manen-0.3.0.dev1 → manen-0.3.0.dev3}/manen/__init__.py

@@ -17,4 +17,4 @@ use the module :py:mod:`~manen.finder` without :py:mod:`~manen.browser` or
 :py:mod:`~manen.page_object_model` without :py:mod:`~manen.browser`.
 """
 
-__version__ = "0.3.0.dev1"
+__version__ = "0.3.0.dev3"

{manen-0.3.0.dev1 → manen-0.3.0.dev3}/manen/browser.py

@@ -185,9 +185,8 @@ class BrowserMixin(WebDriverProtocol):
 class ChromeBrowser(BrowserMixin, Chrome):
     """Wrapper around Selenium ChromeWebDriver providing methods to improve its operability."""
 
-    @classmethod
+    @staticmethod
     def initialize(
-        cls,
         options: ChromeOptions | None = None,
         service: ChromeService | None = None,
         driver_path: str | None = None,
@@ -226,4 +225,4 @@ class ChromeBrowser(BrowserMixin, Chrome):
         if window_size:
             options.add_argument(f"--window-size={window_size[0]},{window_size[1]}")
 
-        return cls(options=options, service=service)
+        return Chrome(options=options, service=service)

manen-0.3.0.dev1/CHANGELOG.md

@@ -1,69 +0,0 @@
-# Changelog
-
-## [0.3.0] - (unreleased)
-
-### Changed
-
-- `manen.page_object_model` has been entirely rewritten to use type annotations
-
-## [0.2.0] - 2022-02-19
-
-### Changed
-
-- Improve CLI command to download drivers executable (now launched with `manen driver download`).
-- Rename `manen.page_object_model.DateTimeElement` (previously `DatetimeElement`).
-- Rename `manen.page_object_model.DOMAccessor` (previously `DomAccessor`).
-
-### Fixed
-
-- Fix link to notebooks in the info section of User Guide
-
-### Added
-
-- Specify link to changelog in documentation in package metadata.
-- Introduce new options in `manen driver download` to set the specifications of the drivers
-  to be downloaded directly from the command line.
-- Add exhaustivity in documentation of `manen.page_object_model` to describe
-  private/special methods and classes other than the ones in `__all__`.
-
-## [0.1.2] - 2022-02-19
-
-**Fix bug in the download workflow of the CLI**
-
-### Fixed
-
-- Fix a `TypeError` in the download workflow (variable wrongly named)
-
-## [0.1.1] - 2022-02-12
-
-**Mainly documentation improvements**
-
-### Changed
-
-- Make documentation publicly available under
-  [kodaho.github.io/manen](https://kodaho.github.io/manen/).
-- Complete `README.md` page.
-- Add the section `About the project` in the documentation (moved from home page).
-- Complete user guides.
-- Rewording and reformatting of several sections.
-
-## [0.1.0] - 2022-01-31
-
-**First release of Manen**
-
-### Added
-
-- `manen.finder.find` allows to easily get element(s) in a WebDriver
-  page. This function support several very different use cases, thanks to several
-  arguments that can be passed to the function.
-- `manen.resource` is a module to easily interact with all the assets
-  needed by Selenium. It allows for example to download the drivers, executable
-  required to launch a WebDriver.
-- `manen.browser` defined `manen.browser.ChromeBrowser`
-  and `manen.browser.BraveBrowser`, an enhanced Selenium WebDriver.
-- `manen.page_object_model` is the implementation of [page object
-  modelling described in Selenium documentation](https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/).
-  Thanks to that, you can describe and interact with the DOM structure through
-  Python classes.
-- a CLI is shipped with the initial release in order to download
-  drivers files.

manen-0.3.0.dev1/docs/source/changelog.rst

@@ -1,108 +0,0 @@
-Changelog
-=========
-
-.. |s| raw:: html
-
-  ⇲ <span style="border-bottom: 1px dashed grey;padding-bottom: 2px; font-size:85%; margin-right:8px">Release date</span> <span style="font-size:90%">
-
-.. |e| raw:: html
-
-  </span>
-
-
-0.3.0
------
-
-|s| (unreleased) |e|
-
-Changed
-^^^^^^^
-- :py:mod:`~manen.page_object_model` has been entirely rewritten to use type annotation instead of `..Element` objects.
-
-|
-
-0.2.0
------
-
-|s| 2022-02-19 |e|
-
-**Rename some classes in** :py:mod:`~manen.page_object_model` **and improve CLI**
-
-Added
-^^^^^
-- Specify link to changelog in documentation in package metadata.
-- Introduce new options in ``manen driver download`` to set the specifications of the drivers
-  to be downloaded directly from the command line.
-- Add exhaustibility in documentation of :py:mod:`~manen.page_object_model` to describe
-  private/special methods and classes other than the ones in ``__all__``.
-
-Changed
-^^^^^^^
-
-- Improve CLI command to download drivers executable (now launched with ``manen driver download``).
-- Rename :py:class:`~manen.page_object_model.DateTimeElement` (previously ``DatetimeElement``).
-- Rename :py:class:`~manen.page_object_model.DOMAccessor` (previously ``DomAccessor``).
-
-Fixed
-^^^^^
-- Fix link to notebooks in the info section of :ref:`User Guide`
-
-|
-
-0.1.2
------
-
-|s| 2022-02-19 |e|
-
-**Fix bug in the download workflow of the CLI**
-
-Fixed
-^^^^^
-
-- Fix a ``TypeError`` in the download workflow (variable wrongly named).
-
-|
-
-0.1.1
------
-
-|s| 2022-02-12 |e|
-
-**Mainly documentation improvements**
-
-Changed
-^^^^^^^
-
-- Make documentation publicly available under
-  `kodaho.github.io/manen <https://kodaho.github.io/manen/>`_.
-- Complete README page.
-- Add the section `About the project` in the documentation (moved from home page).
-- Complete user guides.
-- Rewording and reformatting of several sections.
-
-|
-
-0.1.0
------
-
-|s| 2022-01-31 |e|
-
-**First release of the package**
-
-Added
-^^^^^
-
-- :py:func:`~manen.finder.find` allows to easily get element(s) in a WebDriver
-  page. This function support several very different use cases, thanks to several
-  arguments that can be passed to the function.
-- :py:mod:`~manen.resource` is a module to easily interact with all the assets
-  needed by Selenium. It allows for example to download the drivers, executable
-  required to launch a WebDriver.
-- :py:mod:`~manen.browser` defined :py:class:`~manen.browser.ChromeBrowser`
-  and :py:class:`~manen.browser.BraveBrowser`, an enhanced Selenium WebDriver.
-- :py:mod:`~manen.page_object_model` is the implementation of `page object
-  model <https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/>`_
-  described in Selenium documentation. Thanks to that, you can describe and
-  interact with the DOM structure through Python classes.
-- a :py:mod:`~manen.cli` is shipped with the initial release in order to download
-  drivers files.