Skip to content

Commit 02e0e8c

Browse files
committed
Began developing standalone CLI tool
1 parent 594dd7b commit 02e0e8c

9 files changed

Lines changed: 119 additions & 22 deletions

File tree

‎.devcontainer/devcontainer.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// For format details, see https://aka.ms/devcontainer.json.
2+
{
3+
"name": "jsonresume-docx",
4+
"image": "mcr.microsoft.com/devcontainers/python:3.12",
5+
"updateContentCommand": "pip install --upgrade pip && pip install -e .[dev]"
6+
}

‎.gitignore‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
1+
.ignore-*
2+
3+
*.egg-info/
4+
__pycache__/
5+
*.py[cod]
6+
17
.~*
2-
resume.docx
8+
*resume.docx

‎LICENSE‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎LICENSE.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
The MIT License (MIT)
2+
=====================
3+
4+
Copyright © `2024` `Aram Panasenco`
5+
6+
Permission is hereby granted, free of charge, to any person
7+
obtaining a copy of this software and associated documentation
8+
files (the “Software”), to deal in the Software without
9+
restriction, including without limitation the rights to use,
10+
copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
copies of the Software, and to permit persons to whom the
12+
Software is furnished to do so, subject to the following
13+
conditions:
14+
15+
The above copyright notice and this permission notice shall be
16+
included in all copies or substantial portions of the Software.
17+
18+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
19+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25+
OTHER DEALINGS IN THE SOFTWARE.

‎jsonresume_docx/README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Developing jsonresume_docx
2+
3+
## Setup
4+
5+
### VS Code Dev Containers / GitHub Codespaces
6+
7+
In VS Code, reopen the project in a devcontainer.
8+
Alternatively, open GitHub Codespaces.
9+
Your project should be automatically installed.
10+
11+
### Just pip
12+
13+
```
14+
pip install -e .[dev]
15+
```
16+
17+
## Formatting and linting
18+
19+
We use [ruff](https://docs.astral.sh/ruff/) for formatting and linting Python code.
20+
21+
### Formatting
22+
23+
```
24+
ruff format jsonresume_docx/
25+
```
26+
27+
### linting
28+
29+
List errors:
30+
31+
```
32+
ruff check jsonresume_docx/
33+
```
34+
35+
Auto-fix errors:
36+
37+
```
38+
ruff check --fix jsonresume_docx/
39+
```

‎jsonresume_docx/__init__.py‎

Whitespace-only changes.

‎jsonresume_docx/cli.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import argparse
2+
3+
4+
def cli():
5+
# See https://docs.python.org/3/howto/argparse.html
6+
parser = argparse.ArgumentParser()
7+
8+
9+
if __name__ == "__main__":
10+
cli()

‎pyproject.toml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
[build-system]
2+
requires = ["setuptools >= 61.0"]
3+
build-backend = "setuptools.build_meta"
4+
5+
[project]
6+
name = "jsonresume_docx"
7+
description = "Render your JSON resume as a docx file."
8+
dynamic = ["version"]
9+
dependencies = [
10+
]
11+
requires-python = ">=3.12"
12+
classifiers = [
13+
"License :: OSI Approved :: MIT License",
14+
"Programming Language :: Python :: 3",
15+
"Programming Language :: Python :: 3.12",
16+
]
17+
readme = "README.md"
18+
19+
[project.optional-dependencies]
20+
dev = [
21+
"ruff",
22+
]
23+
24+
[tool.ruff]
25+
line-length = 120
26+
27+
[project.scripts]
28+
jsonresume-docx = "jsonresume_docx.cli:cli"
29+
30+
[tool.setuptools.packages.find]
31+
include = ["jsonresume_docx"]
32+
namespaces = false

‎resume-template.docx‎

10 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)