| Name | managecor JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-10-26 08:05:39 |
| maintainer | None |
| docs_url | None |
| author | infocornouaille |
| requires_python | <4.0,>=3.12 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ManageCor
A command-line tool for managing and using a customized Docker development environment based on Texlive. It includes Python, Pandoc, along with LaTeX packages and Pandoc templates, including eisvogel.latex.
## Features
- 🐳 Docker-based isolated environment
- 📦 Pre-configured TeXLive installation
- 🐍 Python with essential development tools
- 📄 Pandoc with custom templates
- 🎨 ImageMagick support
- 🔄 Automatic updates and configuration
## Prerequisites
- Docker installed on your system
- Python 3.12 or higher
- pip package manager
## Installation
Install `managecor` using pip:
```bash
pip install managecor
```
## Quick Start
Initialize the environment:
```bash
managecor init
```
This will:
- Update configuration from GitHub
- Pull required Docker images
## Commands
| Command | Description |
|---------|-------------|
| `managecor init` | Initialize the environment |
| `managecor update` | Force update Docker images to latest version |
| `managecor update-config` | Update configuration from GitHub |
| `managecor run -- <command>` | Run a command in the Docker container |
## Configuration
The configuration file is stored at `~/.managecor_config.yaml`. It's automatically updated during initialization or via the `update-config` command.
## Docker Images
ManageCor uses two Docker images:
- Base image (`infocornouaille/tools:base`): Contains core tools and dependencies
- Custom image (`infocornouaille/tools:perso`): Includes additional templates and configurations
To force update the Docker images to their latest versions:
```bash
managecor update
```
## Development
To contribute to ManageCor:
1. Fork the repository
2. Create a feature branch
3. Submit a Pull Request
## Troubleshooting
Common issues and solutions:
- For Docker-related issues, ensure Docker daemon is running
- For permission issues on Linux, ensure your user is in the docker group
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgements
- TeXLive team for the base Docker image
- Pandoc team for document conversion tools
- All contributors to the project
Raw data
{
"_id": null,
"home_page": null,
"name": "managecor",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "infocornouaille",
"author_email": "90894019+infocornouaille@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/0c/bd/0f00d80f28049ddc2416d1c86cc19585b01a2af660f427c3bd0edc9e1dba/managecor-0.3.1.tar.gz",
"platform": null,
"description": "# ManageCor\n\n\n\n\n\n\n\n\n\nA command-line tool for managing and using a customized Docker development environment based on Texlive. It includes Python, Pandoc, along with LaTeX packages and Pandoc templates, including eisvogel.latex.\n\n## Features\n\n- \ud83d\udc33 Docker-based isolated environment\n- \ud83d\udce6 Pre-configured TeXLive installation\n- \ud83d\udc0d Python with essential development tools\n- \ud83d\udcc4 Pandoc with custom templates\n- \ud83c\udfa8 ImageMagick support\n- \ud83d\udd04 Automatic updates and configuration\n\n\n## Prerequisites\n\n- Docker installed on your system\n- Python 3.12 or higher\n- pip package manager\n\n## Installation\n\nInstall `managecor` using pip:\n\n```bash\npip install managecor\n```\n\n## Quick Start\n\nInitialize the environment:\n\n```bash\nmanagecor init\n```\n\nThis will:\n- Update configuration from GitHub\n- Pull required Docker images\n\n\n## Commands\n\n| Command | Description |\n|---------|-------------|\n| `managecor init` | Initialize the environment |\n| `managecor update` | Force update Docker images to latest version |\n| `managecor update-config` | Update configuration from GitHub |\n| `managecor run -- <command>` | Run a command in the Docker container |\n\n\n## Configuration\n\nThe configuration file is stored at `~/.managecor_config.yaml`. It's automatically updated during initialization or via the `update-config` command.\n\n## Docker Images\n\nManageCor uses two Docker images:\n\n- Base image (`infocornouaille/tools:base`): Contains core tools and dependencies\n- Custom image (`infocornouaille/tools:perso`): Includes additional templates and configurations\n\nTo force update the Docker images to their latest versions:\n```bash\nmanagecor update\n```\n\n## Development\n\nTo contribute to ManageCor:\n\n1. Fork the repository\n2. Create a feature branch\n3. Submit a Pull Request\n\n## Troubleshooting\n\nCommon issues and solutions:\n\n- For Docker-related issues, ensure Docker daemon is running\n- For permission issues on Linux, ensure your user is in the docker group\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgements\n\n- TeXLive team for the base Docker image\n- Pandoc team for document conversion tools\n- All contributors to the project",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.3.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fd90c75753c5cad512cd90a55dd887ad5063ff990057ece7783a09d76054f4c1",
"md5": "b905681f24a3abb21e4fc8e1ba96c016",
"sha256": "39dd3c75d1c83382ec7e8484e9a5d5387a8bf9a0e743e6de6f8d3dc5c80476e1"
},
"downloads": -1,
"filename": "managecor-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b905681f24a3abb21e4fc8e1ba96c016",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 7287,
"upload_time": "2024-10-26T08:05:38",
"upload_time_iso_8601": "2024-10-26T08:05:38.231026Z",
"url": "https://files.pythonhosted.org/packages/fd/90/c75753c5cad512cd90a55dd887ad5063ff990057ece7783a09d76054f4c1/managecor-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0cbd0f00d80f28049ddc2416d1c86cc19585b01a2af660f427c3bd0edc9e1dba",
"md5": "23f9439e65b8455ccfb1b9c9f88b5bd2",
"sha256": "cf1d3fe3e666c3ddd76073f73a146a256e8db3d050b3fd1018a0a89888e245e5"
},
"downloads": -1,
"filename": "managecor-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "23f9439e65b8455ccfb1b9c9f88b5bd2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 5786,
"upload_time": "2024-10-26T08:05:39",
"upload_time_iso_8601": "2024-10-26T08:05:39.626283Z",
"url": "https://files.pythonhosted.org/packages/0c/bd/0f00d80f28049ddc2416d1c86cc19585b01a2af660f427c3bd0edc9e1dba/managecor-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-26 08:05:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "managecor"
}
