Skip to content

Commit 75d4ae3

Browse files
committed
Fix readme
1 parent 8b0d8fe commit 75d4ae3

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,31 +53,31 @@ masterdata-parser-example
5353
Below you can find an explanation of each file. You can also change the name of the package from `masterdata_parser_example` to your preferred package name `<pkg-name>`.
5454

5555
In order to create your new parser, you have to:
56-
1. Define a new class in `src/<pck-name>/parser.py` instead of `MasterdataParserExample`. We recommend naming it `PckName`.
57-
2. Modify `src/<pck-name>/__init__.py` entry point variables:
56+
1. Define a new class in `src/<pkg-name>/parser.py` instead of `MasterdataParserExample`. We recommend naming it `PkgName`.
57+
2. Modify `src/<pkg-name>/__init__.py` entry point variables:
5858
```python
59-
from .parser import PckName
59+
from .parser import PkgName
6060

6161
# Add more metadata if needed
62-
<pck_name>_entry_point = {
63-
"name": "PckName",
62+
<pkg-name>_entry_point = {
63+
"name": "PkgName",
6464
"description": "A new parser for masterdata.",
65-
"parser_class": PckName,
65+
"parser_class": PkgName,
6666
}
6767
```
6868
3. Modify the `pyproject.toml` line `[project.entry-points."bam.parsers"]` to the new entry point:
6969
```toml
70-
<pck-name>_entry_point = "<pck-name>:<pck_name>_entry_point"
70+
<pkg-name>_entry_point = "<pkg-name>:<pkg-name>_entry_point"
7171
```
72-
4. Modify all other parts in `pyproject.toml` where the `<pck-name>` is `masterdata_parser_example` to your package name.
72+
4. Modify all other parts in `pyproject.toml` where the `<pkg-name>` is `masterdata_parser_example` to your package name.
7373

7474
### Explanation of the files
7575

7676
_To be added!_
7777

7878
## 3. Work in your parser
7979

80-
With the new structure, you can work in your parser to map data from your files into openBIS by modifying `src/<pck-name>/parser.py` and the testing
80+
With the new structure, you can work in your parser to map data from your files into openBIS by modifying `src/<pkg-name>/parser.py` and the testing
8181
module `tests/test_parser.py`.
8282

8383
## 4. Add new parser to `openbis-upload-helper`

0 commit comments

Comments
 (0)