amruthvvkp / aladdin Goto Github PK

Aladdin was a private repo so far to keep the code away from security concerns but looking at a widening colloborators it is a good time to make the repository public. The secrets and any sensitive data can be isolated away from the repository into a settings or environment folder.

GitHub actions can assist in scanning the code for volnerabilities and issues.

It is probably a good time to add docker support to Aladdin and see the potential of deploying it on Azure platform

requirements.txt is missing mypy library for VS Code.
FastAPI 0.70.1 needs a specific version of starlette.
This means we need to in the version of starlette to 0.16.0/skip it from requirements.txt allowing FastAPI to install it from the installation.

The application needs a backend API, in our case the solution is built on top of FastAPI. The objective is to create a base FastAPI application, a PyTest working test based on FastAPI's inbuilt TestClient.

Every project needs a business level documentation and technical level documentation.

For Aladdin we can leverage GitHub wiki to maintain a business level documentation for bridging the gaps between technical and non-technical users.

More details can be discussed in the initial brainstorming session to create a useful wiki.

TestPlan is a great automated testing framework that needs to integrate into Aladdin. This would allow us to integrate our test management tooling, allow us to integrate these automated tests into GitHub actions as a part of GitHub workflows that are triggered every time there is a change made in place for Aladdin.

GitHub supports Pull Request templating which should be added to ensure consistency and quality of Pull Requests created.

Test management is painful and as a developer/tester we know how tedious it gets in the long run. Aladdin is in a very initial state but we need to have a comprehensive test management solution. Our project needs to be a 100% unit test covered project and a very rich functional and automated integration/regression test coverage using TestPlan.

We need a solution that covers -

1. GitHub integration into workflows, issues and actions.
2. Authenticates users and provides roles.
3. Integrates with test frameworks.
4. Provides release based result tracking.
5. Rich test case tagging and linkage.

Considerable tools that we can look for are -

1. TestQuality
2. Testspace

DeepSource Config supports test coverage checks and analytics tracker from GitHub actions. We need to integrate that inside our project.

We need to figure out a basic stock analyzer strategy to filter and analyze stock quality. A quick Jupyter notebook can demo a couple of analysis strategies post which we can zero in on a particular strategy for our first pass into Aladdin's Phase 1 milestones.

We need a FastAPI based web application that has the frontend built with Jinja2 + Semantic UI and the backend handled by FastAPI.

Integrate DeepSource tool which can be very handy with automated code reviews during pull requests into Aladdin. GitHub actions can support DeepSource integration.

Aladdin needs a single point application perspective where all services, API and the web application run together.

Prefect Orion is a technical preview available on GitHub and as an alpha build in pypi.org. Prefect Orion integrates FastAPI and Prefect into a single application eliminating the need to run a docker and docker compose along with apollo image to run a prefect server. Orion deploys an integrated front-end and backend together along with a scalable API. Although this is a technical preview, most of the features we need to build Aladdin into an alpha build should be available for our development.

As an user or developer it is always difficult to maintain versioning more accurately. We certainly need to establish a working solution before we jump on with the code.

GitHub actions is a way to proceed. We can write a *.yml file that can trigger jobs on GitHub post a PR.

//TODO Update gitignore to support egg-info file

https://github.com/amruthvvkp/aladdin/blob/a5b7a314892766bf2def7e057472b7a9dab499ff/.gitignore#L5

DeepSource relies on a .toml file which is failing for certain PR's owing to the fact it looks for YAPF configuration.

To fix this we need to update the deepsource.toml file and setup a yapf configuration inside the project root to get those code quality checks passed.

We need a basic stock analysis model to setup a working PoC for the existing FastAPI model.

Ref: https://towardsdatascience.com/ultimate-setup-for-your-next-python-project-179bda8a7c2c