You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
KKlochko b09d68019f
Update the README to add detailed information about the project.
1 year ago
notification_client Update the CLI help. 1 year ago
tests Project initialization. 1 year ago
.gitignore Project initialization. 1 year ago
COPYING Add the license. 1 year ago
README.md Update the README to add detailed information about the project. 1 year ago
poetry.lock Project initialization. 1 year ago
pyproject.toml Add the license. 1 year ago
requirements.txt Add requirements.txt. 1 year ago

README.md

notification-client

It gets a notification from a server and notifies the user.

Ecosystem

Setup

  • Setup notification-server, before continue.

  • Clone this repository.

  • Ensure that python and pip are installed:

    python --version
    python -m pip -V
    # or
    python3 --version
    python3 -m pip -V
    
  • Create a virtual environment if needed: Using virtualenv:

    virtualenv .venv
    . .venv/bin/activate
    # or
    virtualenv3 .venv
    . .venv/bin/activate
    

    Using poetry:

    poetry shell
    
  • Install the dependencies: Using pip:

    pip install -r requirements.txt
    # or
    pip3 install -r requirements.txt
    

    Using poetry:

    poetry install
    
  • Run the main file: Use options ip and port to change the server address. 127.0.0.1:5555 is the default address.

    python -m notification_client.main --help
    # or
    python3 -m notification_client.main --help
    
    

Commands

  • Connect to the server:

    python -m notification_client.main
    python -m notification_client.main --ip 0.0.0.0 --port 4000
    # or
    python3 -m notification_client.main
    python3 -m notification_client.main --ip 0.0.0.0 --port 4000
    
  • Exit: Ctlr + C (C-c).

Author

Kostiantyn Klochko (c) 2023

License

Under the GNU Affero General Public License v3.0 or later.