chore: update CONTRIBUTING.md

rsJames-ttrpg · Aug 28, 2023 · e7ee442 · e7ee442
1 parent ee6a1ca
commit e7ee442
Showing 1 changed file with 35 additions and 87 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -17,60 +17,58 @@ That will create a directory `./venv/` with the Python binaries and then you wil
 Activate the new environment with:
 
 ```bash
-$ source ./venv/bin/activate
+source ./venv/bin/activate
 ```
 
 Make sure you have the latest pip version on your virtual environment to 
+
 ```bash
-$ python -m pip install --upgrade pip
+python -m pip install --upgrade pip
 ```
 
 ### pip
 
 After activating the environment as described above:
 
 ```bash
-$ pip install -e ".[dev]"
+pip install -e ".[dev]"
 ```
 
-It will install all the dependencies and your local Propan in your local environment.
+It will install all the dependencies and your local FastStream in your local environment.
 
-#### Using your local Propan
+#### Using your local FastStream
 
-If you create a Python file that imports and uses Propan, and run it with the Python from your local environment, it will use your local Propan source code.
+If you create a Python file that imports and uses FastStream, and run it with the Python from your local environment, it will use your local FastStream source code.
 
-And if you update that local Propan source code, as it is installed with `-e`, when you run that Python file again, it will use the fresh version of Propan you just edited.
+And if you update that local FastStream source code, as it is installed with `-e`, when you run that Python file again, it will use the fresh version of FastStream you just edited.
 
 That way, you don't have to "install" your local version to be able to test every change.
 
-To use your local Propan cli type:
+To use your local FastStream cli type:
 
 ```bash
-python -m propan ...
+python -m faststream ...
 ```
 
 ### Tests
 
 #### Pytest
 
-To run tests with your current Propan application and Python environment use:
+To run tests with your current FastStream application and Python environment use:
 
 ```bash
 $ pytest tests
 # or
 $ bash ./scripts/test.sh
 # with coverage output
-$ bash ./scripts/test-cov.sh
+$ bash ./scripts/test-cov.sh -m "all"
 ```
 
 There are some *pytest marks* at project:
 
 * **slow**
 * **rabbit**
-* **nats**
-* **sqs**
 * **kafka**
-* **redis**
 * **all**
 
 Default *pytest* calling runs "not slow" tests.
@@ -81,90 +79,40 @@ To run all tests use:
 pytest -m 'all'
 ```
 
-Also if you didn't up local rabbit or nats intance, run tests without that dependencies
+Also if you didn't up local rabbit or kafka intance, run tests without that dependencies
 
 ```bash
-pytest -m 'not rabbit and not nats'
+pytest -m 'not rabbit and not kafka'
 ```
 
-To run all tests based on RabbitMQ, NATS or another dependencies you should run first following *docker-compose.yml*
+To run all tests based on RabbitMQ, Kafka or another dependencies you should run first following *docker-compose.yml*
 
 ```yaml
 version: "3"
 
 services:
-  rabbit:
-    image: rabbitmq
-    ports:
-      - 5672:5672
-
-  redis:
-    image: redis
-    ports:
-      - 6379:6379
-
-  nats:
-    image: nats
-    command: -js
-    ports:
-      - 4222:4222
-      - 8222:8222  # management
-
-  kafka:
-    image: bitnami/kafka
-    ports:
-      - 9092:9092
-    environment:
-      - KAFKA_ENABLE_KRAFT=yes
-      - KAFKA_CFG_NODE_ID=1
-      - KAFKA_CFG_PROCESS_ROLES=broker,controller
-      - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
-      - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093
-      - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT
-      - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://127.0.0.1:9092
-      - KAFKA_BROKER_ID=1
-      - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=1@kafka:9093
-      - ALLOW_PLAINTEXT_LISTENER=yes
-
-  sqs:
-    image: softwaremill/elasticmq-native
-    ports:
-      - 9324:9324
-```
-
-```bash
-docker compose up -d
-```
-
-#### Hatch
-
-If you are using **hatch** use following environments to run tests:
-
-##### **TEST**
+    rabbitmq:
+        image: rabbitmq:alpine
+        ports:
+          - "5672:5672"
+    kafka:
+        image: bitnami/kafka:3.5.0
+        ports:
+          - "9092:9092"
+        environment:
+          KAFKA_ENABLE_KRAFT: "true"
+          KAFKA_CFG_NODE_ID: "1"
+          KAFKA_CFG_PROCESS_ROLES: "broker,controller"
+          KAFKA_CFG_CONTROLLER_LISTENER_NAMES: "CONTROLLER"
+          KAFKA_CFG_LISTENERS: "PLAINTEXT://:9092,CONTROLLER://:9093"
+          KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP: "CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT"
+          KAFKA_CFG_ADVERTISED_LISTENERS: "PLAINTEXT://127.0.0.1:9092"
+          KAFKA_BROKER_ID: "1"
+          KAFKA_CFG_CONTROLLER_QUORUM_VOTERS: "1@kafka:9093"
+          ALLOW_PLAINTEXT_LISTENER: "true"
 
-Run tests at all python 3.7-3.11 versions.
-
-All python versions should be avalilable at your system.
-
-```bash
-# Run fast smoketesting at all python 3.7-3.11 versions
-$ hatch run test:run
-
-# Run all tests at all python versions
-$ hatch run test:run-all
 ```
 
-##### **TEST-LAST**
-
-Run tests at python 3.11 version.
-
 ```bash
-# Run smoke tests at python 3.11
-$ hatch run test-last:run
-
-# Run all tests at python 3.11
-$ hatch run test-last:run-all
-
-# Run all tests at python 3.11 and show coverage
-$ hatch run test-last:cov
+docker compose up -d
 ```