foxysafe 0.1.0

No project description provided

FoxySafe

Table of Contents

• FoxySafe
  • Table of Contents
  • Install
  • Usage
  • Contribute
    • Development Installation
  • Changelog

Install

pip install foxysafe

Usage

• Copy the default_config.yaml to a custom config.yaml and adjust the settings to your needs.
• Copy the .env.example to ` and adjust the settings to your needs.

If you have cloned the repository and run the package from the source directory with default_config.yaml:

foxysafe

If you have cloned the repository and run the package from the source directory with a path to a custom config PATH_TO/config.yaml:

foxysafe --config-name PATH_TO_CONFIG.yaml

Contribute

Development Installation

git clone https://github.com/Pythoniasm/foxysafe.git
cd foxysafe

python -m pip install --upgrade -e ".[dev]"

Further, you can use Makefile to run linting:

make lint

Changelog

• v0.1.0
  • Initial release
  • Support for:
    • Recursive (group) repository search
    • Repository clone with submodules and branches
    • Download of issue descriptions, notes, info jsons, and their attachements
    • Download of wikis and their attachements
    • Download of snippets, snippet descriptions, info jsons and their attachements