https://github.com/fwartner/spoolman-importer

Import Vendors and Filaments from https://donkie.github.io/SpoolmanDB/
https://github.com/fwartner/spoolman-importer

Last synced: 20 days ago
JSON representation

Import Vendors and Filaments from https://donkie.github.io/SpoolmanDB/

• Host: GitHub
• URL: https://github.com/fwartner/spoolman-importer
• Owner: fwartner
• License: mit
• Created: 2024-06-20T14:35:33.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-20T16:40:35.000Z (6 months ago)
• Last Synced: 2024-10-16T04:45:57.030Z (2 months ago)
• Language: Python
• Size: 23.4 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Spoolman Importer 🎉

Python script to manage your filaments in a [SpoolmanDB](https://github.com/Donkie/SpoolmanDB) format, facilitating the creation and maintenance of a comprehensive and centralized filament database. This database is used in [Spoolman](https://github.com/Donkie/Spoolman) by [Donkie](https://github.com/Donkie).

## Installation

### Using Docker

You can use the pre-built Docker image from GitHub Container Registry.

1. Pull the Docker image:

```bash

docker pull ghcr.io/fwartner/spoolman-importer:main

```

2. Create an `.env` file based on `.env.example` and add your Spoolman URL:

```

SPOOLMAN_URL=http://your-spoolman-url:port

```

3. Run the Docker container with the desired action (create or delete):

To create vendors and filaments:

```bash

docker run --env-file .env ghcr.io/fwartner/spoolman-importer:main create

```

To delete all vendors and filaments:

```bash

docker run --env-file .env ghcr.io/fwartner/spoolman-importer:main delete

```

### Local Setup

1. Clone the repository and install dependencies:

```bash

git clone https://github.com/fwartner/spoolman-importer.git

cd spoolman-importer

pip install -r requirements.txt

```

2. Create an `.env` file based on `.env.example` and add your Spoolman URL:

```

SPOOLMAN_URL=http://your-spoolman-url:port

```

## Usage/Examples

### Create Data

To create vendors and filaments from the provided JSON data, run:

```bash

python main.py create

```

### Delete Data

To delete all vendors and filaments from your Spoolman instance, run:

```bash

python main.py delete

```

## Summary

The script will provide a summary of actions taken during the execution, such as the number of vendors and filaments created or merged.