---
tags: jupyterhub, community-strategic-lead, outreachy, projects, templates
---

# Outreachy - Submit Internship Project Proposal - "JupyterHub pytest plugin"

## 1. Project details

### 1. Approved license

- [x] This is a statement that the project will be released under an OSI-approved open source license which a lot of JupyterHub software is. So check this.

### 2. No proprietary software

- [x] This is a statement that the project will forward FOSS interests, not proprietary. We will do that too, so check this.

### 3. How long has your team been accepting publicly submitted contributions?

- [ ] 0-2 months
- [ ] 3-5 months
- [ ] 6-11 months
- [ ] 1-2 years
- [x] More than 2 years

### 4. How many regular contributors does your team have?

- [ ] 1-2 people
- [ ] 3-5 people ?
- [ ] 6-10 people ?
- [ ] 11-20 people
- [x] 21-50 people
- [ ] 50-100 people
- [ ] More than 100 people

### 5. Project short title

> Short title for this internship project proposal. This should be 100 characters or less, starting with a verb like "Create", "Improve", "Extend", "Survey", "Document", etc. Assume the applicant has never heard of your technology before and keep it simple. The short title will be used in your project page URL, so keep it short.

**Create a reusable JupyterHub pytest plugin**

Possible titles:

1. *"Create a JupyterHub pytest plugin to improve current testing infrastructure of JupyterHub components"*

2. *"Create a JupyterHub pytest plugin to improve the project's current testing infrastructure"*

3. *"Create a hub pytest plugin for JupyterHub and its components"*

4. *"Improve JupyterHub's testing infrastructure by creating a hub pytest plugin"*

5. *"Create a reusable JupyterHub pytest plugin"

### 6. Long description

> Description of the internship project.
>
> Please do not place educational restrictions (such as needing a degree) on this project. Outreachy applicants are judged on their demonstrated skills, not on their educational background. If your project requires knowledge that would normally be learned during a degree, your project contribution tasks should test applicants for that knowledge.
>
> You should exclude applicant skills and communication channels. Those will be added in the next step.
>
> You should also exclude discussion of internship tasks, internship benefits, repository URLs, issue tracker URLs, newcomer tags, or application period contribution tasks. Those are collected in the optional fields below.

.....

[JupyterHub](https://jupyterhub.readthedocs.io/en/stable/index.html) is a modular and extensible project, with parts, like the [proxy](https://jupyterhub.readthedocs.io/en/stable/reference/proxy.html), [authenticator](https://jupyterhub.readthedocs.io/en/stable/reference/authenticators.html) and [spawner](https://jupyterhub.readthedocs.io/en/stable/reference/spawners.html), that can be easily changed and extended. Testing the functionality of these components against JupyterHub is important and it requires various hub setups that sometimes can get complicated.

Currently, each of these hub components and the hub itself define their own testing infrastructure, building everything from the ground up using the [pytest framework](https://docs.pytest.org). But some of this complex work is either repetitive across JupyterHub sub-projects or under-specified for some of them.

Ideally, these common parts would get abstracted into a separate testing framework. This framework should be a [pip-installable pytest plugin](https://docs.pytest.org/en/7.1.x/how-to/writing_plugins.html) that would provide various hub functionalities through [pytest fixtures](https://docs.pytest.org/en/6.2.x/fixture.html). These fixtures would then get re-used by JupyterHub and its components to bootstrap their own testing suite.

Integrating this plugin will drive some important refactoring work of the current testing architecture of JupyterHub and have a great impact in improving the overall test coverage, maintainability and continuity of the JupyterHub project. So, documenting this work is very important and we expect the successful applicant on this project to collaborate with the successful applicant working on our documentation project to document the new testing infrastructure.

We also expect all successful applicants to participate in monthly group calls to discuss broader aspects of open working practices to supplement their internship.

### 7. Minimum system requirements

> What are the minimum computer requirements to contribute to this project during the application period? Examples: Operating system, CPU, memory, and hard drive space.
>
> Many Outreachy applicants have older laptops. Many of them are working with ten year old systems (e.g. 1.6 GHz dual core with 2 GB of RAM). Please evaluate whether your project could better support contributors with older systems.

.....

This project's minimum system requirements are bound by the ability to run the [jupyterhub](https://github.com/jupyterhub/jupyterhub/tree/main/jupyterhub/tests) test suite locally. Because JupyterHub is written in Python and its default proxy, `configurable-http-proxy` is written in Javascript, this means having a system capable of installing a minimum [Python](https://www.python.org/) version of `3.7` and a [NodeJS](https://nodejs.org/en/) `14+`.

Also, because JupyterHub can only run on MacOS or Linux operating systems, a system with either of this operating systems is required. If you are on a Windows machine, you should feel comfortable developing in a Docker container or a virtual VM with the Linux/OSX operating systems.

### 8. How can applicants make a contribution to your project?

> Instructions for how applicants can make contributions during the Outreachy application period.
>
>Make sure to include links to getting started tutorials or documentation, how applicants can find contribution tasks on your project website or issue tracker, who they should ask for tasks, and everything they need to know to get started.

- Quickstart guide: https://jupyterhub.readthedocs.io/en/stable/quickstart.html
- Tutorial: https://github.com/jupyterhub/jupyterhub-tutorial
- Contributing Guide: https://docs.jupyter.org/en/latest/contributing/content-contributor.html
- Our issues for the Contribution Period have been identified with the outreachy-dec22 label and you can find them at this link: https://github.com/search?q=org%3Ajupyterhub+label%3Aoutreachy-dec22+is%3Aopen. Each issue will have it’s own explanation of what and how to contribute as part of this period.

### 9. (Optional) Repository URL

https://github.com/jupyterhub/jupyterhub

### 10. (Optional) Issue tracker

https://github.com/jupyterhub/jupyterhub/issues

### 11. (Optional) Newcomer issue tag

good first issue

### 12. (Optional) Intern tasks

> Description of possible internship tasks. What smaller tasks will they start on? What is the main task or tasks for the internship? Do you have any optional stretch goals?

The intern will:
- identify the reusable hub functionalities across the jupyterhub repository and its components
- create a pip-installable pytest plugin using fixtures created based on these functionalities
- integrate the pytest plugin into JupyterHub's test suite
- document the plugin and the updates on the testing infrastructure
- (strech) integrate the pytest plugin into other JupyterHub components testing suites

### 13. (Optional) Intern benefits

> How will the intern benefit from working with your team on this project? Imagine you're pitching this internship to a promising candidate. What would you say to convince them to apply? For example, what technical and non-technical skills will they learn from working on this project? How will this help them further their career in open source?

The intern will learn about:
- the testing process and tools
- contributing to widely used open source software

### 14. (Optional) Community benefits

> How will this internship project benefit the FOSS community that is funding it?

Integrating this plugin will drive some important refactoring work of the current testing architecture of JupyterHub and have a great impact in improving the overall test coverage, maintainability and continuity of the JupyterHub project.

### 15. (Optional) Unapproved license description

N/A

### 16. (Optional) Proprietary software description

N/A

### 17. Is your project open to new contributors?

- [x] My project is open to new contributors
- [ ] My project already has many strong applicants

## 2. Mentor profile

### Commitment

- [x] Commit to volunteer 5 hours per week from Oct. 1, 2022 to Oct. 31, 2022 to review contributions (Sarah will gather help from other members of JupyterHub too)
- [x] Commit to volunteer 5 hours per week from Dec. 5, 2022 to Mar. 3, 2023 for mentoring support
- [x] Read the mentor [duties](https://www.outreachy.org/mentor/#mentor) and [FAQ](https://www.outreachy.org/mentor/mentor-faq/)
- [x] Understand that mentors will need to sign a [contract](https://www.outreachy.org/generic-mentor-contract-export/) after they accept an applicant as an intern

### Employment

> Outreachy organizers collect statistics about who mentors work for. This allows us to report anonymized statistics to Outreachy sponsors about how many of their employees participate as Outreachy mentors. The statistics help Outreachy organizers secure continued sponsorship.
>
> Some sponsors may want to offer training and other leadership opportunities to employees who are Outreachy mentors. We will ask for your consent before sharing your contact information with Outreachy sponsors.
>
> If you do not want to share your employer with Outreachy organizers, type 'Prefer not to say'.
>
> Your employer will not be displayed to Outreachy applicants.

2i2c

### Mentor profile details

#### 1. Have you ever mentored for Outreachy before?

- [ ] Yes, I have mentored for Outreachy in a past round
- [ ] No but I have mentored for Google Summer of Code or Google Code/Rails Girls Summer of Code/another mentorship programme
- [x] No, I have never mentored before

#### 2. What is your mentorship style?

> Do you prefer short daily standups, longer weekly reports, or informal progress reports? Are you willing to try pair programming when your intern gets stuck? Do you like talking over video chat or answering questions via email? Give the applicants a sense of what it will be like to work with you during the internship.

...

#### 3. How long have you been a contributor on this team?

- [ ] 0-2 months
- [ ] 3-5 months
- [ ] 6-11 months
- [ ] 1-2 years
- [x] More than 2 years

#### 4. What contributions have you made to this team and this community?

....

#### 5. What is your name on the team communication channel?

> This information will be shared with applicants.

GeorgianaElena

## 3. Project skills

### Guidelines

* Skill name (just one skill)
* How much experience does applicant need in that skill?
* Is the skill required, preferred, or optional for applicants?
* **Please do NOT list more than one skill in the skill description.**
* **Please do NOT use full sentences.** The project skills are used as search tags. Keep skill names to 1-3 words.
* **Please do NOT list educational restrictions.**
* **Please do NOT require or prefer applicants that have previously contributed to your community.**

> Repeat this up to three times

* Skill name: Python
* Experience level:
- [ ] No knowledge required
- [ ] Concepts
- [ ] Experimented
- [x] Comfortable
- [ ] Challenge
* Impact of skill on intern selection:
- [ ] Optional
- [ ] Preferred
- [x] Required

---

Skill name: git
* Experience level:
- [ ] No knowledge required
- [ ] Concepts
- [x] Experimented
- [ ] Comfortable
- [ ] Challenge
* Impact of skill on intern selection:
- [ ] Optional
- [x] Preferred
- [ ] Required

---

Skill name: pytest
* Experience level:
- [ ] No knowledge required
- [ ] Concepts
- [ ] Experimented
- [x] Comfortable
- [ ] Challenge
* Impact of skill on intern selection:
- [ ] Optional
- [x] Preferred
- [ ] Required

## 4. Project communication channels

> Repeat for each communication channel

- Communication tool name: gitter
- Communication channel URL: https://gitter.im/jupyterhub/jupyterhub
- Instructions on joining: You will be able to see the conversation in the gitter room even without logging in. To post to the room, you will need to login and can do this via GitHub, or a few other providers.
- Community norms: https://jupyter.org/governance/conduct/code_of_conduct.html
- Communication tool docs URL: https://gitlab.com/gitterHQ/webapp/-/blob/develop/docs/index.md
- Communication tool name: Discourse forum
- Communication channel URL: https://discourse.jupyter.org/
- Instructions on joining: You will be able to see the conversation throughout the forum even without logging in. To reply to a thread or start a new topic, you will need to login and can do this via GitHub or Google.
- Community norms: https://jupyter.org/governance/conduct/code_of_conduct.html, https://discourse.jupyter.org/t/welcome-to-discourse/8, https://discourse.jupyter.org/t/introduce-yourself/17
- Communication tool docs URL: https://www.discourse.org/