Skip to content

Commit b475dc6

Browse files
committed
updates
1 parent 683fdec commit b475dc6

4 files changed

Lines changed: 32 additions & 6 deletions

File tree

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Copilot Instructions for <package_name>
2+
3+
- This is a Python package named `<package_name>`.
4+
- Follow PEP8 style guidelines.
5+
- Use relative imports within the package.
6+
- Write clear docstrings for all public functions and classes.
7+
- Add or update tests in the `tests/` directory for new features or bug fixes and use pytest.
8+
- Use the provided `launch.json` for debugging configurations.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"configurations": [
3+
{ "name": "Python Debugger: Module", "type": "debugpy", "request": "launch", "module": "<package_name>" }
4+
]
5+
}
6+
// TODO: Add more configurations as needed

src/features/creators/templates/newPackageTemplate/README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Project Name
1+
# <project_name>
22

33
> TODO: Write a short description of your project and what it does.
44
55
## Table of Contents
66

7-
- [Project Name](#project-name)
7+
- [\<project\_name\>](#project_name)
88
- [Table of Contents](#table-of-contents)
99
- [How to Run](#how-to-run)
1010
- [How to Package](#how-to-package)
@@ -15,12 +15,14 @@
1515
## How to Run
1616

1717
> TODO: Describe how to use or run your package, with example commands or code.
18-
18+
1. `<run_exec> -m <package_name>`
1919
2020
## How to Package
2121

2222
> TODO: Explain how to build and distribute the package (e.g., using setuptools, poetry, etc.).
2323
24+
1. `<run_exec> -m build`
25+
2426

2527
## How to Test
2628
Tests are stored in the `tests` folder. Tests can be run using pytest with the following command:
@@ -29,7 +31,13 @@ Tests are stored in the `tests` folder. Tests can be run using pytest with the f
2931
## Setup for New Contributors
3032

3133
> TODO: List steps for a new developer to get started.
32-
1.
34+
35+
1. Activate and select the necessary environment, `<activation_command>`
36+
2. Install dependencies:
37+
a. with `<run_exec> pip install -e .[dev]`
38+
b. with `<run_exec> pip install -r dev_requirements.txt` and `<run_exec> pip install -e .`
39+
3. then run the package with: `<run_exec> -m <package_name>`
40+
3341

3442
## License
3543

src/features/creators/templates/newPackageTemplate/pyproject.toml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
[project]
22
name = "package_name"
33
version = "1.0.0"
4-
description = TODO: Add a short description of your package
4+
description = "" #TODO: Add a short description of your package
5+
authors = [{name = "Your Name", email = "your@email.com"}] #TODO: Add your name and email
56
readme = "README.md"
7+
dependencies = [] #TODO: Add your package dependencies here
68

7-
requires-python = ">=3.8"
9+
requires-python = ">=3.9"
810

911
[project.optional-dependencies]
1012
dev-requirements = {file = "dev-requirements.txt"}
@@ -14,6 +16,8 @@ requires = ["setuptools", "wheel"]
1416
build-backend = "setuptools.build_meta"
1517

1618

19+
[project.scripts]
20+
# Add your CLI entry points here
1721

1822

1923

0 commit comments

Comments
 (0)