xxxpython_package_namexxx

xxxpackage_descriptionxxx.

Documentation for xxxpython_package_namexxx is hosted by Read the Docs (development version and main version). The code lives on github. Please report any issues you find here. If you want to contribute, pull requests are welcomed! true

Features

Installation

The easiest way to install xxxpython_package_namexxx is to use conda:

conda create -n xxxpython_package_namexxx python=3.11 pip xxxpython_package_namexxx -c conda-forge
conda activate xxxpython_package_namexxx

To upgrade to the latest version of xxxpython_package_namexxx use the command:

conda upgrade xxxpython_package_namexxx -c conda-forge

It is also possible to install via pip if required:

pip install xxxpython_package_namexxx

Or you can clone the github repo and install from a local version of the code:

git clone git@github.com:thespacedoctor/xxxpython_package_namexxx.git
cd xxxpython_package_namexxx
python setup.py install

To check installation was successful run xxxpython_package_namexxx -v. This should return the version number of the install.

Initialising xxxpython_package_namexxx

Before using xxxpython_package_namexxx you need to use the init command to generate a user settings file. Running the following creates a yaml settings file in your home folder under ~/.config/xxxpython_package_namexxx/xxxpython_package_namexxx.yaml:

xxxpython_package_namexxx init

The file is initially populated with xxxpython_package_namexxx's default settings which can be adjusted to your preference.

If at any point the user settings file becomes corrupted or you just want to start afresh, simply trash the xxxpython_package_namexxx.yaml file and rerun xxxpython_package_namexxx init.

You are now ready to start using xxxpython_package_namexxx.