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

improvement: add in config to enrich pypi metadata #3660

Merged
merged 6 commits into from
May 21, 2024
Merged

Conversation

armandobelardo
Copy link
Contributor

This allow for configuring package metadata at the

Top level:

api: ./openapi.yml
metadata:
  description: this is the desc for my package
  authors:
     - email: support@buildwithfern.com
        name: Armando

Group level:

...
groups:
  my_group:
    metadata:
      description: this is the desc for my package
      authors:
       - email: support@buildwithfern.com
          name: Armando
    generators:
      - name: fernapi/fern-python-sdk
         ...

And finally the actual generator, which allows you to specify more metadata, specific to the output location:

...
groups:
  my_group:
    generators:
      - name: fernapi/fern-python-sdk
         metadata:
            description: this is the desc for my package
            keywords:
              - science
              - data analysis
            documentationLink: ""
            homepageLink: ""
            authors:
              - email: support@buildwithfern.com
                 name: Armando
         ...

If you configure at multiple levels, the more specific layer takes precedent

Copy link
Member

@dsinghvi dsinghvi left a comment

Choose a reason for hiding this comment

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

i read through the code and it looks right to me but i think it would be great if we could write a snapshot test to make sure that convertGeneratorsConfiguration works how we want it to (snapshot the outputs)

@armandobelardo armandobelardo merged commit e17e745 into main May 21, 2024
27 checks passed
@armandobelardo armandobelardo deleted the ab/FER-1652 branch May 21, 2024 01:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants