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.

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

Create requirement files for dev and prod #58

Conversation

Arsentau
Copy link
Contributor

@Arsentau Arsentau commented Oct 14, 2023

What's this PR do?

Summary of changes in this PR or what it accomplishes.

Given that requiremets file has the dependencies for development and for production mixed.
The dependencies were splited in two separate files:

  • one for prod
  • one for dev that also references to the prod requirements in order to be able of install all the dependencies with one command
    Besides that Readme file was updated with the corresponding references

@ulises-jeremias @matiasz8

Summary by CodeRabbit

  • Documentation: Updated installation instructions in the README files for both fastapi-gql and fastapi-base projects. The new instructions provide separate steps for installing development and production requirements.
  • New Feature: Integrated GraphQL functionality into the fastapi-gql project with the addition of the strawberry-graphql dependency.
  • Refactor: Streamlined the project's requirements by removing factory-boy, Faker, and flake8 dependencies from the fastapi-gql project. These tools were previously used for test data generation but are no longer needed.
  • Chore: Added factory-boy, Faker, and flake8 to the development requirements for the fastapi-gql project, enhancing the development and testing process.

@Arsentau Arsentau added Hacktoberfest dependencies Pull requests that update a dependency file labels Oct 14, 2023
@Arsentau Arsentau self-assigned this Oct 14, 2023
@coderabbitai
Copy link

coderabbitai bot commented Oct 14, 2023

Rate Limit Exceeded

@Arsentau has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 17 minutes and 1 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, convert this PR to a draft and then mark it as ready for review again to re-trigger the review. Alternatively, you can push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per repository.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 170c6d3 and d99ae8d.

Walkthrough

The changes primarily focus on refining the project's dependencies and updating the installation instructions. The shift in requirements suggests a move towards GraphQL functionality, with the removal of test data generation dependencies and the addition of strawberry-graphql.

Changes

File Path Summary
examples/fastapi-gql/README.md Updated installation instructions for development and production requirements.
examples/fastapi-gql/requirements-*.txt Added strawberry-graphql and removed factory-boy, Faker, and flake8.
examples/fastapi-base/README.md Changed step 3 to install requirements from a new, unspecified requirements file.

🐇

In the land of code, where logic is king,

Changes are afoot, new dependencies we bring.

From factory-boy and Faker, we part,

For strawberry-graphql is now at the heart.

The READMEs updated, with instructions so clear,

Celebrate the changes, for better code is near! 🎉


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • Mention @coderabbitai in any review comment for bot assistance.
  • Note: Review comments are made on code diffs or files, not on the PR overview.

Pause Incremental Reviews

  • Insert @coderabbitai: ignore in the PR description to halt the bot's ongoing reviews. Remove the line to resume.
  • Additionally, enter @coderabbitai pause to halt the bot's ongoing reviews as any issue or review comment. To
    resume reviews, enter @coderabbitai resume as any issue or review comment.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Commits Files that changed from the base of the PR and between 7b3d9d6 and 170c6d3.
Files selected for processing (3)
  • examples/fastapi-gql/README.md (1 hunks)
  • examples/fastapi-gql/requirements-dev.txt (1 hunks)
  • examples/fastapi-gql/requirements-prod.txt (1 hunks)
Files skipped from review due to trivial changes (3)
  • examples/fastapi-gql/README.md
  • examples/fastapi-gql/requirements-dev.txt
  • examples/fastapi-gql/requirements-prod.txt

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 1

Commits Files that changed from the base of the PR and between 170c6d3 and cd13963.
Files selected for processing (1)
  • examples/fastapi-base/README.md (1 hunks)

examples/fastapi-base/README.md Outdated Show resolved Hide resolved
@Arsentau Arsentau force-pushed the feature/fastapi-gql-split-requirements-file branch from cd13963 to 204f501 Compare October 14, 2023 11:41
Copy link
Member

@ulises-jeremias ulises-jeremias left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔥

@ulises-jeremias ulises-jeremias merged commit 937262b into nanlabs:main Oct 17, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file Hacktoberfest hacktoberfest-accepted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants