Skip to content

Commit ed3a6f5

Browse files
committed
Remove outdated information from readme.
1 parent 2077a1e commit ed3a6f5

File tree

2 files changed

+13
-89
lines changed

2 files changed

+13
-89
lines changed

README.md

+12-88
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,12 @@ This repository ships with the [DoIt!](https://pydoit.org/) task automation tool
1616

1717
The following DoIt! tasks are available:
1818

19-
- `doc`: Generates Markdown tables from common-schema
20-
- `render_template`: Demonstrate how to render a template
21-
- `schema`: Generates JSON schema from common-schema
22-
- `test`: Performs unit tests and example file validation tests
23-
- `validate`: Validates common-schema against meta-schema
19+
- `generate_markdown`: Generates Markdown tables from common-schema
20+
- `generate_web_docs`: Generates web documentation from templates
21+
- `generate_meta_schemas`: Generates validation files for common-schema
22+
- `generate_json_schemas`: Generates JSON schema from common-schema
23+
- `validate_schemas`: Validates common-schema against meta-schema
24+
- `generate_cpp_project`: Generates header and source files, with basic CMake build integration
2425

2526

2627
Development Workflow
@@ -32,96 +33,19 @@ For those who wish to develop the Schema205 repository directly, we are using th
3233

3334
Following are some considerations you should go through to configure your environment correctly for development and exploration.
3435

35-
1. **Install Poetry**
36-
37-
Be sure to install [Poetry](https://python-poetry.org/docs/#installation) per the instructions from the Poetry website.
38-
39-
2. **Install Python and support multiple Python versions on one machine**
40-
41-
If you don't desire to support multiple versions of Python, then you need only ensure that you have at least one version of Python installed. This project requires Python 3.7 or higher. Please see the [Python Website](https://www.python.org/) for installation instructions for your operating system.
42-
43-
If you wish to support multiple versions of Python during development, there are several options. One simple option is to just ensure you start up your command prompt (i.e., shell) with the Python version you wish to develop with.
44-
45-
For something more sophisticated, we recommend [mini-conda](https://docs.conda.io/en/latest/miniconda.html), a free minimal installer for Conda. Conda is an open-source package and environment management system that runs on Windows, macOS, and Linux. Use the following steps:
46-
47-
a) [install mini-conda](https://docs.conda.io/en/latest/miniconda.html).
48-
49-
b) [start conda](https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html#starting-conda). This will bring up a shell window that "knows" about conda capabilities. Windows note: be sure to follow the recommended start procedure -- generally conda *cannot* be started from a native shell prompt (due to path issues).
50-
51-
c) Create an environment for the version of Python you would like to use with Poetry and this project by typing the following at the conda shell:
52-
53-
> (base) conda create -n py37 python=3.7
54-
55-
Note: these environments persist between usage so you only need to create the environment once.
56-
57-
This will create a conda environment named "py37" that only has Python 3.7 (and its dependencies) installed.
58-
If you want to use Python 3.9, you could type `conda create -n py39 python=3.9`, for example.
59-
The `-n` flag is short for the `--name` of the new conda environment.
60-
You have a lot of freedom for the names provided there are no spaces or exotic characters.
61-
The `python=3.7` part specifies that the new conda environment will use Python version 3.7.
62-
You can create as many environments with differing versions of Python as you desire.
63-
64-
Once the desired environments are created, you can activate an environment by typing:
65-
66-
> (base) conda activate py37
67-
68-
When you are done with the environment, type:
69-
70-
> (py37) conda deactivate
71-
72-
... or simply close your command shell when done.
73-
74-
Once you've created the environment you desire, on subsequent use, you just need to start conda and activate the environment you want.
75-
76-
Select the desired Python environment and activate it before proceeding to the next step.
77-
78-
3. **Install dependencies**
79-
80-
To install dependencies, go to the root folder of this repository and type:
81-
82-
> poetry install
83-
84-
This will install all of the normal and developer dependencies.
85-
If you have done this previously and there are no changes to the library versions being used, nothing will happen.
86-
87-
4. **Using an editor**
36+
1. **WIP: Using uv to install the package and dependencies**
37+
1. **Using an editor**
8838

8939
You can use any editor you desire to edit or explore the Python code and schema documents in our repository.
9040

9141
We recommend [Visual Studio Code](https://code.visualstudio.com/) because of its strong Python integration.
9242

93-
To get Visual Studio Code to work with Poetry, first follow steps 1-3 above.
94-
95-
macOS: a) if you do not have command-line integration, [follow these instructions](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line), and restart your shell. b) follow steps 1-3.
96-
97-
Windows: Follow steps 1-3 above. The `code` command (see below) is already integrated into your shell.
98-
99-
From within your running Python environment, type:
100-
101-
> poetry shell
102-
103-
This activates the virtual environment for Poetry. Then enter:
104-
105-
```
106-
> cd toolkit-205/schema-205
107-
> code .
108-
```
109-
110-
This launches Visual Studio Code from within your Poetry environment.
111-
At the bottom left, choose the Python version you wish to use with the given environment.
112-
113-
Open a terminal window TODO
114-
115-
You're now ready to develop using Visual Studio Code!
116-
117-
5. **Use the project**
118-
119-
To run the various scripts and commands of the project, you can use the [DoIt!](https://pydoit.org/) file as follows:
43+
1. From a command shell
44+
1. From inside VS Code
12045

121-
> poetry run doit
46+
1. **Use the project**
12247

123-
The first part of the command, `poetry run`, uses Poetry to place the remaining part of the command within a Python virtual environment with all dependencies setup.
124-
The second part of the command, `doit`, runs all of the tasks available in the `dodo.py` file.
48+
WIP: doit instructions
12549

12650

12751
### Developing with Toolkit 205

dodo.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def task_generate_markdown():
6565

6666

6767
def task_generate_web_docs():
68-
"""Generate markdown documentation from templates"""
68+
"""Generate web documentation from templates"""
6969
return {
7070
"task_dep": [f"validate_schemas", f"generate_json_schemas", f"validate_example_files"],
7171
"file_dep": [schema.file_path for schema in data_model_205.schemas]

0 commit comments

Comments
 (0)