Fix name of pkg

Added readme

Author: JosePizarro3

README.md

@@ -1,2 +1,85 @@
 # masterdata-parser-example
-An example parser and masterdata definitions for openBIS.
+
+An example parser for openBIS using the bam-masterdata interface.
+
+This repository is intended to be used as a template or example to be forked to generate new parsers in openBIS
+integrated with the `openbis-upload-helper`.
+
+
+## 1. Create a new parser repository
+
+You can either [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) or [use this repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) as a template.
+
+Click on the button **Use this template** and choose **Create a new repository**:
+
+<!--Image use this template-->
+
+You will be prompted to create a new repository. Choose:
+- Place to host the repository (organization or your own profile). In our case, we selected _BAMResearch_
+- Give a name. We named our repository _masterdata-parser-nerxiv_
+- Write a short description.
+- Choose _Public_ visibility.
+
+<!-- Image of create a new repository -->
+
+
+## 2. Define your parser entry point
+
+With your new repository created, clone it locally:
+```bash
+git clone https://github.com/BAMresearch/masterdata-parser-example.git
+```
+
+**Note**: we will be using our example with this repository to showcase the commands. Please, change the corresponding
+paths to your own repository naming conventions.
+
+We have now a new folder, `masterdata-parser-example`, containing the following structure:
+```sh
+masterdata-parser-example
+├── LICENSE
+├── pyproject.toml
+├── README.md
+├── src
+│   ├── masterdata_parser_example
+│       ├── __init__.py
+│       ├── parser.py
+│       └── _version.py
+└── tests
+    ├── __init__.py
+    ├── conftest.py
+    └── test_parser.py
+```
+
+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>`.
+
+In order to create your new parser, you have to:
+1. Define a new class in `src/<pck-name>/parser.py` instead of `MasterdataParserExample`. We recommend naming it `PckName`.
+2. Modify `src/<pck-name>/__init__.py` entry point variables:
+```python
+from .parser import PckName
+
+# Add more metadata if needed
+<pck_name>_entry_point = {
+    "name": "PckName",
+    "description": "A new parser for masterdata.",
+    "parser_class": PckName,
+}
+```
+3. Modify the `pyproject.toml` line `[project.entry-points."bam.parsers"]` to the new entry point:
+```toml
+<pck-name>_entry_point = "<pck-name>:<pck_name>_entry_point"
+```
+4. Modify all other parts in `pyproject.toml` where the `<pck-name>` is `masterdata_parser_example` to your package name.
+
+### Explanation of the files
+
+_To be added!_
+
+## 3. Work in your parser
+
+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
+module `tests/test_parser.py`.
+
+## 4. Add new parser to `openbis-upload-helper`
+
+Once your new parser has been developed and tested, you can add it to the registry of parsers in the `openbis-upload-helper`. We recommend you contacting the maintainers of the application with a link to your parser repository.

pyproject.toml

@@ -43,7 +43,7 @@ dev = [
 
 [tool.ruff]
 # Exclude a variety of commonly ignored directories.
-include = ["src/masterdata_example_parser/*.py", "tests/*.py"]
+include = ["src/masterdata_parser_example/*.py", "tests/*.py"]
 exclude = [
     ".bzr",
     ".direnv",
@@ -124,7 +124,7 @@ package-dir = { "" = "src" }
 where = ["src"]
 
 [tool.setuptools_scm]
-write_to = "src/masterdata_example_parser/_version.py"
+write_to = "src/masterdata_parser_example/_version.py"
 
 [project.entry-points."bam.parsers"]
-masterdata_parser_example_entry_point = "masterdata_example_parser:masterdata_parser_example_entry_point"
+masterdata_parser_example_entry_point = "masterdata_parser_example:masterdata_parser_example_entry_point"