OSL Internship 2024-01 Ideas

[xmnlab]

Project Idea 1: Improve Scicookie Documentation

Abstract

The documentation of scicookie is incomplete and outdated for both the users and the developers of the package. This project will aim to improve the documentation by adding examples, creating landing page, adding API documentation, improving the contributing guidelines, and improving the user and developer guide.

License

BSD 3 Clause: https://github.com/osl-incubator/scicookie/blob/main/LICENSE

Code of Conduct

https://github.com/osl-incubator/scicookie/blob/main/CODE_OF_CONDUCT.md

Current State

• Currently, the documentation was created using jupyter-book

Tasks

• docs: Change scicookie documentation from jbook to mkdocs using material theme #176
• docs: Improve and update documentation content #191

Expected Outcomes

• documentation using mkdocs
• update the current documentation content
• add new content to the documentation, such as tutorial
• create a blog post about how to use scicookie

Details

• Prerequisites:
  • Python
  • Object-oriented programming (OOP)
  • YAML
• Expected Time: 240 hours
• Potential Mentor(s): Saransh Chopra

References

• https://www.mkdocs.org/
• https://squidfunk.github.io/mkdocs-material/

[xmnlab]

Project Idea 2: Improve Scicookie experience using Cruft

Abstract

Scicookie currently uses cookieninja as a template engine, but we are looking to migrate it to Cruft. Cruft will allow updating a project structure already created by scicookie. This project will also investigate using multiple backends for templating, as scientific-python/cookie does.

License

BSD 3 Clause: https://github.com/osl-incubator/scicookie/blob/main/LICENSE

Code of Conduct

https://github.com/osl-incubator/scicookie/blob/main/CODE_OF_CONDUCT.md

Current State

• Currently, scicookie uses cookieninja

Tasks

• Migrate from scicookie to Cruft #193

Expected Outcomes

• move from cookieninja to cruft
• update the documentation
• update the tests

Details

• Prerequisites:
  • Python
  • Object-oriented programming (OOP)
  • YAML
• Expected Time: 240 hours
• Potential Mentor(s): Saransh Chopra

References

• https://www.mkdocs.org/
• https://squidfunk.github.io/mkdocs-material/
• https://cruft.github.io/cruft/

[xmnlab]

Project Idea 3: Developing SciCookie further

Abstract

Scicookie is under active development and the applicants can pick up issues from the GitHub issue tracker (after discussing with the mentors) to work on them. This project can include:

• Fixing the truncated input in CLI.
• Implement depends_on properly, a way to have conditionally questions
• Updating pre-commit configurations.
• Adding support for Code of Conduct.
• Adding new documentation engines.

License

BSD 3 Clause: https://github.com/osl-incubator/scicookie/blob/main/LICENSE

Code of Conduct

https://github.com/osl-incubator/scicookie/blob/main/CODE_OF_CONDUCT.md

Tasks

• Fixing the truncated input in CLI. #194
• Implement depends_on properly, a way to have conditionally questions #195
• template: Add support for prettier #180
• template: Improve the configuration for the lib linters in pyproject.toml and/or .pre-commit-config.yaml #178
• Remove support for blue #186
• Add Python CoC support #143
• template: Add quarto as an option for the documentation engine #172

Expected Outcomes

• Implement the assigned tasks
• Add and update documentation for the new implementation
• Add proper tests for the new implementation
• Create a blog post for each new implementation

Details

• Prerequisites:
  • Python
  • Object-oriented programming (OOP)
  • YAML
• Expected Time: 240 hours
• Potential Mentor(s): Saransh Chopra

References

• https://www.mkdocs.org/
• https://squidfunk.github.io/mkdocs-material/
• https://cruft.github.io/cruft/