Metadata-Version: 2.4
Name: xxxpython_package_namexxx
Version: 0.1.dev135
Summary: xxxpackage_descriptionxxx
Author-email: xxxauthorNamexxx <xxxauthor@email.xxx>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/thespacedoctor/xxxpython_package_namexxx
Keywords: xxxpackage_keywords_comma_sepxxx
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyyaml
Requires-Dist: fundamentals
Provides-Extra: docs
Requires-Dist: build; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-autodoc2; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: furo; extra == "docs"
Requires-Dist: sphinx-inline-tabs; extra == "docs"
Requires-Dist: sphinxext-opengraph; extra == "docs"
Requires-Dist: sphinx-autobuild; extra == "docs"
Requires-Dist: linkify-it-py; extra == "docs"
Requires-Dist: sphinxcontrib-mermaid; extra == "docs"
Requires-Dist: sphinx-togglebutton; extra == "docs"
Requires-Dist: sphinx_copybutton; extra == "docs"
Requires-Dist: sphinx_tippy; extra == "docs"
Requires-Dist: sphinx_design; extra == "docs"
Requires-Dist: pygments-csv-lexer; extra == "docs"
Requires-Dist: sphinxcontrib-svg2pdfconverter; extra == "docs"
Requires-Dist: sphinx-remove-toctrees; extra == "docs"
Requires-Dist: sphinxcontrib.bibtex; extra == "docs"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: nose2; extra == "tests"
Provides-Extra: dev
Requires-Dist: xxxpython_package_namexxx[docs,tests]; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# xxxpython\_package\_namexxx

<!-- INFO BADGES -->  

[![](https://img.shields.io/pypi/pyversions/xxxpython_package_namexxx)](https://pypi.org/project/xxxpython_package_namexxx/)
[![](https://img.shields.io/pypi/v/xxxpython_package_namexxx)](https://pypi.org/project/xxxpython_package_namexxx/)
[![](https://img.shields.io/conda/vn/conda-forge/xxxpython_package_namexxx)](https://anaconda.org/conda-forge/xxxpython_package_namexxx)
[![](https://pepy.tech/badge/xxxpython_package_namexxx)](https://pepy.tech/project/xxxpython_package_namexxx)
[![](https://img.shields.io/github/license/thespacedoctor/xxxpython_package_namexxx)](https://github.com/thespacedoctor/xxxpython_package_namexxx)

<!-- STATUS BADGES -->  

[![](https://soxs-eso-data.org/ci/buildStatus/icon?job=xxxpython_package_namexxx%2Fmain&subject=build%20main)](https://soxs-eso-data.org/ci/blue/organizations/jenkins/xxxpython_package_namexxx/activity?branch=main)
[![](https://soxs-eso-data.org/ci/buildStatus/icon?job=xxxpython_package_namexxx%2Fdevelop&subject=build%20dev)](https://soxs-eso-data.org/ci/blue/organizations/jenkins/xxxpython_package_namexxx/activity?branch=develop)
[![](https://cdn.jsdelivr.net/gh/thespacedoctor/xxxpython_package_namexxx@main/coverage.svg)](https://raw.githack.com/thespacedoctor/xxxpython_package_namexxx/main/htmlcov/index.html)
[![](https://readthedocs.org/projects/xxxpython_package_namexxx/badge/?version=main)](https://xxxpython_package_namexxx.readthedocs.io/en/main/)
[![](https://img.shields.io/github/issues/thespacedoctor/xxxpython_package_namexxx/type:%20bug?label=bug%20issues)](https://github.com/thespacedoctor/xxxpython_package_namexxx/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+bug%22+) 

*xxxpackage\_descriptionxxx*.

Documentation for xxxpython\_package\_namexxx is hosted by [Read the Docs](https://xxxpython_package_namexxx.readthedocs.io/en/main/) ([development version](https://xxxpython_package_namexxx.readthedocs.io/en/develop/) and [main version](https://xxxpython_package_namexxx.readthedocs.io/en/main/)). The code lives on [github](https://github.com/thespacedoctor/xxxpython_package_namexxx). Please report any issues you find [here](https://github.com/thespacedoctor/xxxpython_package_namexxx/issues). If you want to contribute, [pull requests](https://github.com/thespacedoctor/xxxpython_package_namexxx/pulls) are welcomed! 
true


## Features

* 



## Installation

The easiest way to install xxxpython_package_namexxx is to use `conda`:

``` bash
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:

``` bash
conda upgrade xxxpython_package_namexxx -c conda-forge
```

It is also possible to install via pip if required:

``` bash
pip install xxxpython_package_namexxx
```

Or you can clone the [github repo](https://github.com/thespacedoctor/xxxpython_package_namexxx) and install from a local version of the code:

``` bash
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](https://learnxinyminutes.com/docs/yaml/) settings file in your home folder under `~/.config/xxxpython_package_namexxx/xxxpython_package_namexxx.yaml`:

```bash
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.
