Merge preparation

- Merged main into branch - Added changes summary to changelog - Restored sync between index and readme
VianneyMI · Oct 26, 2023 · 44ad67a · 44ad67a
1 parent 9525ed3
commit 44ad67a
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 7 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,5 +1,11 @@
 # Release Notes
 
+## 0.17.0
+
+### Docs
+
+* First version of the documentation :champagne: !
+
 ## 0.16.2
 
 ### Fixes

diff --git a/docs/index.md b/docs/index.md
@@ -167,3 +167,7 @@ results = list(cursor)
 #print(results)
 ```
 
+## **Going further**
+
+* Check out the [full documentation](https://vianneymi.github.io/monggregate/) for more examples.
+* Check out this [medium article](https://medium.com/@vianney.mixtur_39698/mongo-db-aggregations-pipelines-made-easy-with-monggregate-680b322167d2).
diff --git a/pyproject.toml b/pyproject.toml
@@ -10,6 +10,7 @@ version = "0.16.2"
 description = "MongoDB aggregation pipelines made easy. Joins, grouping, counting and much more..."
 readme = "README.md"
 authors = [{ name = "Vianney Mixtur", email = "vianney.mixtur@outlook.fr" }]
+documentation = "https://vianneymi.github.io/monggregate/
 license = { file = "LICENSE" }
 classifiers = [
     "License :: OSI Approved :: MIT License",

diff --git a/readme.md b/readme.md
@@ -39,8 +39,10 @@ import pymongo
 from monggregate import Pipeline, S
 
 # Creating connexion string securely
+# You need to create a .env file with your password
 load_dotenv(verbose=True)
-PWD = os.environ["MONGODB_PASSWORD"]
+PWD = os.environ["MONGODB_PASSWORD"] 
+
 MONGODB_URI = f"mongodb+srv://dev:{PWD}@myserver.xciie.mongodb.net/?retryWrites=true&w=majority"
 
 # Connect to your MongoDB cluster:
@@ -64,8 +66,9 @@ pipeline.match(
 # Executing the pipeline
 curosr = db["movies"].aggregate(pipeline.export())
 
+# Printing the results
 results = list(curosr)
-assert results
+#print(results) # Uncomment to see the results
 ```
 
 
@@ -115,7 +118,6 @@ cursor = db["movies"].aggregate(pipeline.export())
 # Printing the results
 results = list(cursor)
 #print(results)
-assert results
 
 ```
 
@@ -163,12 +165,9 @@ cursor = db["movies"].aggregate(pipeline.export())
 # Printing the results
 results = list(cursor)
 #print(results)
-assert results, results
-
-
 ```
 
 ## **Going further**
 
-* Check out the [documentation](https://vianneymi.github.io/monggregate/) for more examples.
+* Check out the [full documentation](https://vianneymi.github.io/monggregate/) for more examples.
 * Check out this [medium article](https://medium.com/@vianney.mixtur_39698/mongo-db-aggregations-pipelines-made-easy-with-monggregate-680b322167d2).