baseapp-e2e: move to baseapp-backend

.github/workflows/github-actions.yml

@@ -20,10 +20,6 @@ jobs:
     uses: ./.github/workflows/project-workflow.yml
     with:
       project: baseapp-social-auth
-  baseapp-e2e:
-    uses: ./.github/workflows/project-workflow.yml
-    with:
-      project: baseapp-e2e
   baseapp-profiles:
     uses: ./.github/workflows/project-workflow.yml
     with:

.github/workflows/sonar-actions.yml

@@ -20,11 +20,6 @@ jobs:
     with:
       project: baseapp-social-auth
     secrets: inherit
-  baseapp-e2e:
-    uses: ./.github/workflows/sonar-workflow.yml
-    with:
-      project: baseapp-e2e
-    secrets: inherit
   baseapp-profiles:
     uses: ./.github/workflows/sonar-workflow.yml
     with:

README.md

@@ -22,7 +22,7 @@ Integration with Cloudflare Stream for file streaming
 
 This app uses django provided permission and group model and provides the ability to add roles to a django model, and make views from the [django-restframework](https://www.django-rest-framework.org/) check for them. A **Permission** represents the lowest single unit of access. A **Group** is a collection of Permissions. A **Role** can have many Permision Groups, many Permissions and many **Excluded Permissions**. The access of a Role is the aggregation of its single Permissions + the permissions on its **Permission** Groups - its Excluded Permissions.
 
-## [baseapp-e2e](baseapp-e2e)
+## [baseapp-e2e](baseapp/baseapp_e2e)
 
 Utilities for performing E2E (End-To-End) tests with front-end client. (Database initialization and seeding)
 

baseapp/MANIFEST.in

@@ -74,3 +74,8 @@ include baseapp_chats/README.md
 recursive-include baseapp_chats/templates *
 recursive-include baseapp_chats/static *
 recursive-include baseapp_chats/locale *
+
+include baseapp_e2e/README.md
+recursive-include baseapp_e2e/templates *
+recursive-include baseapp_e2e/static *
+recursive-include baseapp_e2e/locale *

baseapp/baseapp_chats/README.md

@@ -1,3 +1,87 @@
 # BaseApp Chats
 
-This package has been moved to [baseapp-packend](https://pypi.org/project/baseapp-backend/) package.
+This package provides a simple chat system for your project, where multiple profiles can chat with each other.
+
+## Requirements:
+```
+- **baseapp-core** >= 0.3.7
+- **baseapp-profile** >= 0.2.4
+```
+
+Run `pip install baseapp-chats`
+And make sure to add the frozen version to your `requirements/base.txt` file
+
+If you want to develop, [install using this other guide](#how-to-develop).
+
+## How to use
+
+Add `baseapp_chats` to your project's `INSTALLED_APPS`
+
+Make sure your Profile's GraphQL Object Types extends `ChatRoomsInterface` interface:
+
+```python
+from baseapp_chats.graphql.interfaces import ChatRoomsInterface
+
+class ProfileObjectType(DjangoObjectType):
+    class Meta:
+        interfaces = (relay.Node, ChatRoomsInterface)
+```
+
+This is not necessary if you are using the `baseapp-profile` as it is without a custom ProfileObjectType implementation.
+
+Expose `ChatsMutations`, `ChatsQueries` and `ChatsSubscriptions` in your GraphQL/graphene endpoint, like:
+
+```python
+from baseapp_chats.graphql.mutations import ChatsMutations
+from baseapp_chats.graphql.queries import ChatsQueries
+from baseapp_chats.graphql.subscriptions import ChatsSubscriptions
+
+
+class Query(graphene.ObjectType, ChatsQueries):
+    pass
+
+
+class Mutation(graphene.ObjectType, ChatsMutations):
+    pass
+
+
+class Subscription(graphene.ObjectType, ChatsSubscriptions):
+    pass
+
+
+schema = graphene.Schema(query=Query, mutation=Mutation, subscription=Subscription)
+```
+
+Those will expose the following queries, mutations and subscriptions:
+
+### Queries
+
+- `chatRoom(id: ID!)`: Return a specific chatRoom
+
+### Mutations
+
+- `chatRoomCreate(profileId: ID!, participants: [ID!]!)`: Create a chatRoom with your profile and multiple participants
+- `chatRoomSendMessage(roomId: ID!, profileId: ID!, content: String!, inReplyToId: ID)`: Send a message in a room, using a specific profile. Optionally, you can reply to a message by passing the `inReplyToId` argument.
+- `chatRoomReadMessages(roomId: ID!, profileId: ID!, messageIds: [ID])`: Mark messages in a room as read by a specific profile, if `messageIds` is not passed, all messages will be marked as read.
+
+### Subscriptions
+
+- `chatRoomOnRoomUpdate(profileId: ID!)`: Subscribe to chat rooms updates under your current profile
+- `chatRoomOnMessagesCountUpdate(profileId: ID!)`: Subscribe to unread/read messages count updates under your current profile
+- `chatRoomOnMessage(roomId: ID!)`: Subscribe to new messages in a specific room
+
+## How to develop
+
+Clone the project inside your project's backend dir:
+
+```
+git clone git@github.com:silverlogic/baseapp-backend.git
+```
+
+And manually install the package:
+
+```
+pip install -e baseapp-backend/baseapp-chats
+```
+
+The `-e` flag will make it like any change you make in the cloned repo files will effect into the project.

baseapp-e2e/README.md → baseapp/baseapp_e2e/README.md

@@ -74,7 +74,7 @@ There is a [test project](testproject/) with a complete demo set up.
 Install in your environment:
 
 ```bash
-pip install baseapp-e2e
+pip install baseapp-backend
 ```
 
 ### Settings