Skip to content

Latest commit

 

History

History
108 lines (76 loc) · 3.03 KB

INSTALL.md

File metadata and controls

108 lines (76 loc) · 3.03 KB

Our logo

Building the nest for you

Install Nester

Notice

Nester is currently released to PyPi, the Python Packaging Index.


Index


Install via pip

To install Nester from PyPi, make sure you have pip aswell as a reasonably up-to-date version of Python 3 installed.

Nester has been validated to work with Python 3.10 and 3.11. However, it should work with older versions of python too, as long as they can provide an appropriate version of both Click and Questionary.

If you run an outdated version of Python and run into issues with Nester, please note that we cannot provide a backwards patch for these problems.

Open a Terminal and run:

pip install nester-struct

Note: The package name nester was already occupied by the time we released Nester to PyPi. Although we could not find a package with that name.
We are currently investigating if we can get the name assigned to us.


Install as rpm

NOTE: This functionality is currently undergoing changes. We recommend installing Nester via pip to receive the newest changes to the project.

Note: The .rpm-release of Nester can straggle behind in features to its pip release. This is because the OBS build is being maintained by a volunteer so it can take a couple days for changes to be released here.

To install Nester via its OBS repository follow these steps (on openSUSE):

  1. Add the repository
sudo zypper addrepo https://download.opensuse.org/repositories/home:kodymo/openSUSE_Tumbleweed/home:kodymo.repo
  1. Refresh your repositories
sudo zypper ref
  1. Install Nester
sudo zypper install python3-nester

Note: The repository contains three builds for nester for Python 3.9, 3.10 and 3.11. zypper will automatically decide which version to use when running the command above.

You can visit the repository on the package maintainer's OBS account.


Build from source

Nester uses setuptools as its build tool and pyproject.toml and setup.cfg as configuration files. To install the requirements for Nester, you can use pip as follows:

  1. Change to the Nester directory:
cd nester
  1. Install the dependencies listed in setup.cfg using pip:
pip install -e .

This should install all necessary requirements for nester aswell as nester itself.

You can try it out now by calling

nester -h

Note: If you encounter any issues with dependencies or installation, please refer to the troubleshooting section or reach out for help in the issues section or via email.


Thank you for using Nester!
- Your Nester Team