Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Architecture] - Migrate to FastAPI to Expand Functionality #52

Open
miguelcsx opened this issue Aug 6, 2024 · 0 comments
Open

[Architecture] - Migrate to FastAPI to Expand Functionality #52

miguelcsx opened this issue Aug 6, 2024 · 0 comments
Assignees
@miguelcsx
Labels
help wanted Extra attention is needed

Comments

@miguelcsx
Copy link
Owner

Description

The use of the Discord API is limited, and the tool has the potential to grow significantly if it is developed as a command API instead of being confined to just a Discord bot.

Background

Currently, we have a well-documented and efficient Discord bot that performs various commands. However, we believe that by externalizing our commands, we can enhance the tool's versatility and usability across different applications beyond Discord.

Proposal

  1. Abstract Command Logic: Refactor the existing command logic to be independent of the Discord bot implementation.
  2. Create a Command API: Develop a RESTful API (or another suitable architecture) to expose the commands for use in other applications.
  3. Documentation and Examples: Provide comprehensive documentation and examples for using the command API in various contexts.
  4. Backward Compatibility: Ensure that the Discord bot continues to function seamlessly with the new command API.

Benefits

  1. Increased Usability: Allows the commands to be integrated into various platforms and applications, not limited to Discord.
  2. Enhanced Flexibility: Developers can leverage the command API to create custom integrations and workflows.
  3. Future-Proofing: Prepares the tool for potential expansions and integrations with other services and platforms.

Potential Challenges

  1. Refactoring Effort: Significant refactoring might be required to decouple the command logic from the Discord bot.
  2. API Design: Designing a robust and secure API that can handle the commands efficiently.
  3. Testing and Maintenance: Ensuring thorough testing of the new API and maintaining backward compatibility with the existing bot.

Conclusion

By expanding our command functionality beyond the Discord bot and creating a versatile command API, we can significantly increase the tool's reach and utility, opening up new possibilities for integration and growth.
@miguelcsx miguelcsx added the help wanted Extra attention is needed label Aug 6, 2024
@miguelcsx miguelcsx self-assigned this Aug 6, 2024
miguelcsx added a commit that referenced this issue Aug 6, 2024
@miguelcsx
refac: #52 install fastapi library
1e3c728 
- added new package to start the migration
miguelcsx added a commit that referenced this issue Aug 6, 2024
@miguelcsx
refac: #52 install fastapi library
335ae42 
- added new package to start the migration
ElCabris pushed a commit that referenced this issue Aug 12, 2024
@miguelcsx
refactor: #52 install fastapi library (#53)
41c6df5 
- added new package to start the migration
miguelcsx added a commit that referenced this issue Aug 16, 2024
@miguelcsx
refac: #52 install fastapi library
1073318 
- added new package to start the migration
miguelcsx added a commit that referenced this issue Aug 29, 2024
@miguelcsx
feat: #52 create basic structure with fastapi
1886d0f 
- added some models and schemas

- still using sqlachemy
miguelcsx added a commit that referenced this issue Aug 30, 2024
@miguelcsx
feat: #52 create basic structure with fastapi
2755a32 
- added some models and schemas

- still using sqlachemy
miguelcsx added a commit that referenced this issue Aug 31, 2024
@miguelcsx
feat: #52 create basic structure with fastapi (#55)
95276ef 
- added some models and schemas

- still using sqlachemy
miguelcsx added a commit that referenced this issue Aug 31, 2024
@miguelcsx
feat: #52 update models
f50b4cd 
- re-design the models to adapt new workflow
miguelcsx added a commit that referenced this issue Aug 31, 2024
@miguelcsx
feat: #52 update models
72281e5 
- re-design the models to adapt new workflow
miguelcsx added a commit that referenced this issue Aug 31, 2024
@miguelcsx
feat: #52 update models (#56)
8614423 
- re-design the models to adapt new workflow
miguelcsx added a commit that referenced this issue Sep 2, 2024
@miguelcsx
refactor: #52 install fastapi library (#53)
822b516 
- added new package to start the migration
miguelcsx added a commit that referenced this issue Sep 2, 2024
@miguelcsx
feat: #52 create basic structure with fastapi (#55)
e7e968d 
- added some models and schemas

- still using sqlachemy
miguelcsx added a commit that referenced this issue Sep 2, 2024
@miguelcsx
feat: #52 update models (#56)
167d7f1 
- re-design the models to adapt new workflow
miguelcsx added a commit that referenced this issue Sep 2, 2024
@miguelcsx
refactor: #52 install fastapi library (#53)
b0a6144 
- added new package to start the migration
miguelcsx added a commit that referenced this issue Sep 2, 2024
@miguelcsx
feat: #52 create basic structure with fastapi (#55)
1c13a67 
- added some models and schemas

- still using sqlachemy
miguelcsx added a commit that referenced this issue Sep 2, 2024
@miguelcsx
feat: #52 update models (#56)
12c9b5f 
- re-design the models to adapt new workflow
miguelcsx added a commit that referenced this issue Sep 2, 2024
@miguelcsx
feat: #52 created schemas for newest models
efe154f 
- updated the schemas in order to meet the new architecture

- cleaned the dependencies at
miguelcsx added a commit that referenced this issue Sep 2, 2024
@miguelcsx
feat: #52 created schemas for newest models
7b09a31 
- updated the schemas in order to meet the new architecture

- cleaned the dependencies at `requirements.txt`

- include code coverage for actions
miguelcsx added a commit that referenced this issue Sep 2, 2024
@miguelcsx
feat: #52 created schemas for newest models
cd86eef 
- updated the schemas in order to meet the new architecture

- cleaned the dependencies at `requirements.txt`

- include code coverage for actions
miguelcsx added a commit that referenced this issue Sep 2, 2024
@miguelcsx
feat: #52 created schemas for newest models
d229973 
- updated the schemas in order to meet the new architecture

- cleaned the dependencies at `requirements.txt`

- include code coverage for actions
miguelcsx added a commit that referenced this issue Sep 4, 2024
@miguelcsx
feat: #52 created schemas for newest models (#60)
c54424b 
- updated the schemas in order to meet the new architecture

- cleaned the dependencies at `requirements.txt`

- include code coverage for actions
miguelcsx added a commit that referenced this issue Sep 10, 2024
@miguelcsx
feat: #52 created missing repositories
915c84c 
- update also endpoints

- change api welcome message
miguelcsx added a commit that referenced this issue Sep 10, 2024
@miguelcsx
feat: #52 created missing repositories
9f12de8 
- update also endpoints

- change api welcome message
miguelcsx added a commit that referenced this issue Sep 26, 2024
@miguelcsx
feat: #52 created missing repositories (#61)
05579c2 
- update also endpoints

- change api welcome message
miguelcsx added a commit that referenced this issue Sep 26, 2024
@miguelcsx
refac: #52 update folder structure as package
ea28260 
- made the rest api a package

- this could be useful when creating cli
miguelcsx added a commit that referenced this issue Sep 26, 2024
@miguelcsx
refac: #52 update folder structure as package (#63)
218cc5c 
- made the rest api a package

- this could be useful when creating cli
miguelcsx added a commit that referenced this issue Sep 26, 2024
@miguelcsx
refac: #52 update folder structure as package (#63)
2bd869a 
- made the rest api a package

- this could be useful when creating cli
miguelcsx added a commit that referenced this issue Sep 26, 2024
@miguelcsx
feat(aura): #52 coverage and tests
4078635 
- updated pydantic

- created simple test for user model

- used a test database file, in memory doesn't work too well

- modified routing plural naming to singular
miguelcsx added a commit that referenced this issue Sep 26, 2024
@miguelcsx
feat(aura): #52 coverage and tests
936a53c 
- updated pydantic

- created simple test for user model

- used a test database file, in memory doesn't work too well

- modified routing plural naming to singular
miguelcsx added a commit that referenced this issue Sep 26, 2024
@miguelcsx
feat(aura): #52 coverage and tests
8afac5d 
- updated pydantic

- created simple test for user model

- used a test database file, in memory doesn't work too well

- modified routing plural naming to singular
miguelcsx added a commit that referenced this issue Sep 26, 2024
@miguelcsx
feat(aura): #52 coverage and tests
a0be2d3 
- updated pydantic

- created simple test for user model

- used a test database file, in memory doesn't work too well

- modified routing plural naming to singular
miguelcsx added a commit that referenced this issue Sep 26, 2024
@miguelcsx
feat(aura): #52 coverage and tests (#65)
ade7f3e 
- updated pydantic

- created simple test for user model

- used a test database file, in memory doesn't work too well

- modified routing plural naming to singular
This was referenced Sep 26, 2024
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@miguelcsx miguelcsx

Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@miguelcsx