dev-code 0.1.0__tar.gz → 0.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,159 @@
1
+ Metadata-Version: 2.4
2
+ Name: dev-code
3
+ Version: 0.1.1
4
+ Summary: Project · editor · container — simplified
5
+ License-File: LICENSE
6
+ Requires-Python: >=3.10
7
+ Description-Content-Type: text/markdown
8
+
9
+ # dev-code
10
+
11
+ ```text
12
+ _ _
13
+ | | | |
14
+ __| | _____ ________ ___ ___ __| | ___
15
+ / _` |/ _ \ \ / /______/ __/ _ \ / _` |/ _ \
16
+ | (_| | __/\ V / | (_| (_) | (_| | __/
17
+ \__,_|\___| \_/ \___\___/ \__,_|\___|
18
+ project · editor · container — simplified
19
+ ```
20
+
21
+ [![Coverage](https://codecov.io/gh/dacrystal/dev-code/branch/main/graph/badge.svg)](https://codecov.io/gh/dacrystal/dev-code)
22
+
23
+ [![PyPI version](https://img.shields.io/pypi/v/dev-code)](https://pypi.org/project/dev-code/)
24
+ [![Python 3.10+](https://img.shields.io/pypi/pyversions/dev-code)](https://pypi.org/project/dev-code/)
25
+ [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
26
+
27
+ **One command. Any project. The right devcontainer.**
28
+
29
+ `dev-code` is a CLI that opens any project in VS Code inside a devcontainer — instantly, using reusable templates you define once. No more hunting config files. No more copy-pasting `devcontainer.json`.
30
+
31
+ ---
32
+
33
+ ## Install
34
+
35
+ ```bash
36
+ pip install dev-code
37
+ ```
38
+
39
+ Or run without installing via **uvx**:
40
+
41
+ ```bash
42
+ uvx dev-code
43
+ ```
44
+
45
+ **Tip:** Add an alias for the fastest workflow:
46
+
47
+ ```bash
48
+ alias dev-code="uvx dev-code"
49
+ ```
50
+
51
+ > Requires: VS Code with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) + Docker
52
+
53
+ ---
54
+
55
+ ## Quick-start
56
+
57
+ ```bash
58
+ # 1. Seed your first template
59
+ dev-code init
60
+
61
+ # 2. Open any project in a devcontainer
62
+ dev-code open dev-code ~/projects/my-app
63
+
64
+ # That's it. VS Code opens, container spins up.
65
+ ```
66
+
67
+ ---
68
+
69
+ ## Features
70
+
71
+ - **One-command open** — `dev-code open <template> <path>` launches VS Code in a devcontainer instantly
72
+ - **Reusable templates** — define your devcontainer once, reuse it across every project
73
+ - **Built-in template** — ships with the `dev-code` template out of the box
74
+ - **Custom templates** — create and manage your own with `dev-code new`
75
+ - **File sync on launch** — copy credentials, configs, and secrets into the container via a `dev-code` customization block in `devcontainer.json`
76
+ - **WSL support** — works natively on Windows Subsystem for Linux
77
+ - **Container dashboard** — see all running devcontainers with `dev-code ps`
78
+ - **Works with existing config** — no new format, just standard `devcontainer.json`
79
+
80
+ ---
81
+
82
+ ## Commands
83
+
84
+ | Command | Description |
85
+ |---|---|
86
+ | `dev-code init` | Seed the built-in `dev-code` template into your template directory |
87
+ | `dev-code open <template> <path>` | Open a project in VS Code using a devcontainer template |
88
+ | `dev-code new <name> [base]` | Create a new template (optionally based on an existing one) |
89
+ | `dev-code edit [template]` | Open a template for editing in VS Code |
90
+ | `dev-code list [--long]` | List available templates |
91
+ | `dev-code ps` | Show running devcontainers |
92
+
93
+ ### Options
94
+
95
+ | Flag | Command | Description |
96
+ |---|---|---|
97
+ | `--dry-run` | `open` | Print the devcontainer URI and copy plan without executing |
98
+ | `--container-folder` | `open` | Override the in-container workspace path |
99
+ | `--timeout` | `open` | Seconds to wait for container to start (default: 300) |
100
+ | `--edit` | `new` | Open the new template for editing immediately after creation |
101
+ | `--long` | `list` | Show full paths alongside template names |
102
+ | `-v, --verbose` | all | Enable debug logging |
103
+
104
+ ---
105
+
106
+ ## Templates
107
+
108
+ Templates are directories containing a `.devcontainer/devcontainer.json` file. They live in `~/.local/share/dev-code/templates/` by default (XDG-compliant), or wherever `$DEVCODE_TEMPLATE_DIR` points.
109
+
110
+ ### Get started
111
+
112
+ ```bash
113
+ dev-code init # copies the built-in dev-code template
114
+ dev-code new my-python # creates a new template from the default base
115
+ dev-code new my-node dev-code # creates a new template based on dev-code
116
+ dev-code edit my-python # open the template in VS Code to customise it
117
+ ```
118
+
119
+ ### File sync — copy files into the container on launch
120
+
121
+ Add a `customizations.dev-code.cp` section to your `devcontainer.json` to copy files from your host into the running container:
122
+
123
+ ```json
124
+ {
125
+ "customizations": {
126
+ "dev-code": {
127
+ "cp": [
128
+ {
129
+ "source": "${localEnv:HOME}/.claude/credentials.json",
130
+ "target": "/home/vscode/.claude/credentials.json"
131
+ }
132
+ ]
133
+ }
134
+ }
135
+ }
136
+ ```
137
+
138
+ Supports `owner`, `group`, `permissions`, and `Override` fields per entry. Use `source/.` to copy the contents of a directory.
139
+
140
+ ---
141
+
142
+ ## Contributing
143
+
144
+ Contributions are welcome! To get started:
145
+
146
+ ```bash
147
+ git clone https://github.com/dacrystal/dev-code
148
+ dev-code open dev-code ./dev-code
149
+ ```
150
+
151
+ The repo includes a `dev-code` devcontainer — open it with itself.
152
+
153
+ Please open an issue before submitting large changes.
154
+
155
+ ---
156
+
157
+ ## License
158
+
159
+ MIT
@@ -5,6 +5,8 @@ build-backend = "hatchling.build"
5
5
  [project]
6
6
  name = "dev-code"
7
7
  dynamic = ["version"]
8
+ description = "Project · editor · container — simplified"
9
+ readme = "README.md"
8
10
  requires-python = ">=3.10"
9
11
  dependencies = []
10
12
 
dev_code-0.1.0/PKG-INFO DELETED
@@ -1,5 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: dev-code
3
- Version: 0.1.0
4
- License-File: LICENSE
5
- Requires-Python: >=3.10
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes