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

Generate project structure using repo-config #1

Merged
merged 8 commits into from
Feb 27, 2024

Conversation

llucax
Copy link
Contributor

@llucax llucax commented Feb 26, 2024

  • Generate project using repo-config
  • Remove example files
  • Add part:client GitHub label
  • Fix the default branch for docs editing
  • Sort and fix project's keywords
  • Add project classifier
  • Improve TOML formatting
  • Remove TODOs that don't need addressing
  • Add dependency to grpcio

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
@leandro-lucarella-frequenz leandro-lucarella-frequenz added part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:enhancement New feature or enhancement visitble to users part:client Affects the client code labels Feb 26, 2024
@leandro-lucarella-frequenz leandro-lucarella-frequenz added this to the v0.1.0 milestone Feb 26, 2024
"cookiecutter": {
"Introduction": "",
"type": "lib",
"name": "client-microgrid",
Copy link
Contributor

Choose a reason for hiding this comment

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

Interesting, I used frequenz-dispatch here for the other repo. Following this logic I should have used dispatch-actor

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, just dispatch in this case. Not sure if you used the actor or lib type for it, but in both cases dispatch would have been the right choice, if it is a pure actor repo, it will build all the names using the frequenz-actor- prefix, for lib projects it just uses frequenz- and I think a -python suffix for the repo name. But this only affects the defaults, if you changed the other variables then it has no effect.

See https://frequenz-floss.github.io/frequenz-repo-config-python/v0.9/user-guide/start-a-new-project/#template-variables-reference (although I just realized there is no mention of how exactly other variables are built from this one).

Copy link
Contributor

Choose a reason for hiding this comment

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

I did consult the reference before filling it out ;)
Still wasn't clear if I should follow a certain pattern, e.g. we have every package prefixed with frequenz- etc

@leandro-lucarella-frequenz leandro-lucarella-frequenz requested review from Marenz, a team and thea-leake and removed request for a team February 26, 2024 17:17
@llucax llucax added this pull request to the merge queue Feb 27, 2024
Merged via the queue into frequenz-floss:v0.x.x with commit fabaaea Feb 27, 2024
1 check passed
@llucax llucax deleted the generated branch February 27, 2024 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:client Affects the client code part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:enhancement New feature or enhancement visitble to users
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants