added initializing docs

docs/changelog.md

@@ -13,6 +13,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 _Due to the changes mentioned above, a few item functionalities may be disabled. For example, the `name` and `description` properties can now be accessed and modified using attribute functionality_
 
+### Added
+- Constructor methods: `from_dict`, `from_pandas`, `from_yaml`
+
+
 ## [0.35.7] -- 2023-07-19
 ### Fixed 
 - incorrect setting of sample and subsample indexes using from_dict function (#452)

docs/initialize.md

@@ -0,0 +1,46 @@
+# How to initiate peppy using different methods
+
+peppy supports multiple ways to initiate a project. The most common way is to use a configuration file. 
+However, peppy also supports using a csv file (sample sheet), and a yaml file (sample sheet).
+Additionally, peppy can be initiated using Python objects such as a pandas dataframe or a dictionary.
+
+## 1. Using a configuration file
+```python
+import peppy
+project = peppy.Project("path/to/project/config.yaml")
+```
+
+## 2. Using csv file (sample sheet)
+```python
+import peppy
+project = peppy.Project("path/to/project/sample_sheet.csv")
+```
+
+## 3. Using yaml sample sheet
+```python
+import peppy
+project = peppy.Project.from_yaml("path/to/project/sample_sheet.yaml")
+```
+
+
+## 4. Using a pandas dataframe
+```python
+import pandas as pd
+import peppy
+df = pd.read_csv("path/to/project/sample_sheet.csv")
+project = peppy.Project.from_pandas(df)
+```
+
+## 5. Using a peppy generated dict
+```python
+import peppy
+project = peppy.Project.from_dict({`_config`: str,
+                                   `_samples`: list | dict,
+                                   `_subsamples`: list[list | dict]})
+```
+
+## 6. Using a csv file from a url
+```python
+import peppy
+project = peppy.Project("example_url.csv")
+```

mkdocs.yml

@@ -14,6 +14,7 @@ nav:
     - How to use append sample modifier: feature1_append.md
     - How to use imply sample modifier: feature2_imply.md
     - How to validate a PEP: validating.md
+    - How to initialize a peppy: initialize.md
   - Reference:
     - API: autodoc_build/peppy.md
     - Support: support.md

peppy/_version.py

@@ -1 +1 @@
-__version__ = "0.40.0a5"
+__version__ = "0.40.0a6"

peppy/project.py

@@ -290,7 +290,7 @@ def create_samples(self, modify: bool = False):
         """
         self._samples: List[Sample] = self.load_samples()
         if self.samples is None:
-            _LOGGER.info("No samples found in the project.")
+            _LOGGER.debug("No samples found in the project.")
 
         if modify:
             self.modify_samples()