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

fix(pkg): Add project metadata long description (readme) #248

Merged
merged 4 commits into from
Mar 25, 2024

Conversation

Satarupa22-SD
Copy link
Contributor

Resolves #240
@xmnlab


![logo_scicookie.png](images%2Flogo_scicookie.png)

**SciCookie** is a Cookiecutter template designed to simplify scientific Python project creation. It provides a boilerplate structure with recommended tools, workflows, and industry best practices, saving developers time and effort. Built upon the PyOpenSci recommendations, it offers a foundation that adheres to scientific Python standards while remaining customizable to specific project needs.
Copy link
Member

@xmnlab xmnlab Mar 24, 2024

Choose a reason for hiding this comment

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

Suggested change
**SciCookie** is a Cookiecutter template designed to simplify scientific Python project creation. It provides a boilerplate structure with recommended tools, workflows, and industry best practices, saving developers time and effort. Built upon the PyOpenSci recommendations, it offers a foundation that adheres to scientific Python standards while remaining customizable to specific project needs.
**SciCookie** is a project template designed to simplify scientific Python project creation. It provides an initial structure with recommended tools, workflows, and industry best practices, saving developers time and effort. Built upon the PyOpenSci recommendations, it offers a foundation that adheres to scientific Python standards while remaining customizable to specific project needs.

@xmnlab
Copy link
Member

xmnlab commented Mar 24, 2024

thanks @Satarupa22-SD for working on that, appreciate that.

I just added a small comment here.

other than that, please run pre-commit install in your scicookie environment and run pre-commit run --all-files to fix the issue that is raising on CI.

for more information, please take a look here: https://osl-incubator.github.io/scicookie/contributing/#setting-up-for-local-development.

note: maybe we would need to discuss a bit more the logo later, check if that works fine with favicon etc .. but for now it looks great. thanks!

@Satarupa22-SD
Copy link
Contributor Author

@xmnlab I have updated the description.md file.

@xmnlab xmnlab changed the title Add project description on pypi(#240) fix(pkg) Add project description on pypi(#240) Mar 25, 2024
@xmnlab xmnlab changed the title fix(pkg) Add project description on pypi(#240) fix(pkg): Add project metadata description(#240) Mar 25, 2024
@xmnlab xmnlab changed the title fix(pkg): Add project metadata description(#240) fix(pkg): Add project metadata long description (readme) Mar 25, 2024
@xmnlab
Copy link
Member

xmnlab commented Mar 25, 2024

Later we would need to discuss about README.md, docs/index.md and the docs/description.md .. we need to simplify that .. otherwise we will have eventually outdated info for forgetting to update one of these files.

@xmnlab xmnlab merged commit 6be8e03 into osl-incubator:main Mar 25, 2024
12 checks passed
@Satarupa22-SD
Copy link
Contributor Author

@xmnlab sure :)

Copy link

🎉 This PR is included in version 0.7.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing Project Description on PyPI
2 participants