semvec/pypi-packages huggingface dataset:
registrant-alert 1.0.0
Python client library for Registrant Alert API.
License: MIT
Requires Python: >=3.6
Keywords: registrant,registrantalert,alert,api,whois,whoisxmlapi

.. image:: https://img.shields.io/badge/License-MIT-green.svg
    :alt: registrant-alert-py license
    :target: https://opensource.org/licenses/MIT

.. image:: https://img.shields.io/pypi/v/registrant-alert.svg
    :alt: registrant-alert-py release
    :target: https://pypi.org/project/registrant-alert

.. image:: https://github.com/whois-api-llc/registrant-alert-py/workflows/Build/badge.svg
    :alt: registrant-alert-py build
    :target: https://github.com/whois-api-llc/registrant-alert-py/actions

========
Overview
========

The client library for
`Registrant Alert API <https://registrant-alert.whoisxmlapi.com/>`_
in Python language.

The minimum Python version is 3.6.

Installation
============

.. code-block:: shell

    pip install registrant-alert

Examples
========

Full API documentation available `here <https://registrant-alert.whoisxmlapi.com/api/documentation/making-requests>`_

Create a new client
-------------------

.. code-block:: python

    from registrantalert import *

    client = Client('Your API key')

Make basic requests
-------------------

.. code-block:: python

    # Get the number of domains.
    terms = {
        'include': ['blog']
    }
    result = client.preview(basic_terms=terms)
    print(result.domains_count)

    # Get raw API response
    raw_result = client.raw_data(
        basic_terms=terms,
        response_format=Client.XML_FORMAT,
        mode=Client.PREVIEW_MODE)

    # Get a list of registered/dropped domains (up to 10,000)
    result = client.purchase(
        basic_terms=terms
    )

Advanced usage
-------------------

Extra request parameters

.. code-block:: python

    advanced_terms = [{
        'field': Fields.registrant_contact_organization,
        'term': 'Airbnb, Inc.',
        'exactMatch': True
    }]
    since_date = datetime.date(2021, 8, 12)
    result = client.purchase(
        advanced_terms=advanced_terms,
        since_date=since_date,
        punycode=False)

Response model overview
-----------------------

.. code-block:: python

    Response:
        - domains_count: int
        - domains_list: [Domain]
            - domain_name: str
            - date: datetime.date
            - action: str



Changelog
=========

1.0.0 (2021-09-14)
------------------

* First release
just-a-test-project 0.0.30
A project for testing https://github.com/creditornot/wolt-python-package-cookiecutter
License: MIT
Requires Python: >=3.7.1,<4.0

# Just a test project

[![PyPI](https://img.shields.io/pypi/v/just-a-test-project?style=flat-square)](https://pypi.python.org/pypi/just-a-test-project/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/just-a-test-project?style=flat-square)](https://pypi.python.org/pypi/just-a-test-project/)
[![PyPI - License](https://img.shields.io/pypi/l/just-a-test-project?style=flat-square)](https://pypi.python.org/pypi/just-a-test-project/)
[![Coookiecutter - Wolt](https://img.shields.io/badge/cookiecutter-Wolt-00c2e8?style=flat-square&logo=cookiecutter&logoColor=D4AA00&link=https://github.com/woltapp/wolt-python-package-cookiecutter)](https://github.com/woltapp/wolt-python-package-cookiecutter)


---

**Documentation**: [https://creditornot.github.io/just-a-test-project](https://creditornot.github.io/just-a-test-project)

**Source Code**: [https://github.com/creditornot/just-a-test-project](https://github.com/creditornot/just-a-test-project)

**PyPI**: [https://pypi.org/project/just-a-test-project/](https://pypi.org/project/just-a-test-project/)

---

A project for testing wolt-python-package-cookiecutter

## Installation

```sh
pip install just-a-test-project
```

## Development

* Clone this repository
* Requirements:
  * [Poetry](https://python-poetry.org/)
  * Python 3.7+
* Create a virtual environment and install the dependencies

```sh
poetry install
```

* Activate the virtual environment

```sh
poetry shell
```

### Testing

```sh
pytest
```

### Documentation

The documentation is automatically generated from the content of the [docs directory](./docs) and from the docstrings
 of the public signatures of the source code. The documentation is updated and published as a [Github project page
 ](https://pages.github.com/) automatically as part each release.

### Releasing

Trigger the [Draft release workflow](https://github.com/creditornot/just-a-test-project/actions/workflows/draft_release.yml)
(press _Run workflow_). This will update the changelog & version and create a GitHub release which is in _Draft_ state.

Find the draft release from the
[GitHub releases](https://github.com/creditornot/just-a-test-project/releases) and publish it. When
 a release is published, it'll trigger [release](.github/workflows/release.yml) workflow which creates PyPI
 release and deploys updated documentation.

### Pre-commit

Pre-commit hooks run all the auto-formatters (e.g. `black`, `isort`), linters (e.g. `mypy`, `flake8`), and other quality
 checks to make sure the changeset is in good shape before a commit/push happens.

You can install the hooks with (runs for each commit):

```sh
pre-commit install
```

Or if you want them to run only for each push:

```sh
pre-commit install -t pre-push
```

Or if you want e.g. want to run all checks manually for all files:

```sh
pre-commit run --all-files
```

---

This project was generated using the [wolt-python-package-cookiecutter](https://github.com/woltapp/wolt-python-package-cookiecutter) template.