Skip to content

Commit

Permalink
docs: Update prose to format code block and docs (sparckles#356)
Browse files Browse the repository at this point in the history
* Updates prose to format code block and docs

* running on . files
  • Loading branch information
rachfop authored Jan 16, 2023
1 parent 2f27fdc commit 69e1b8e
Show file tree
Hide file tree
Showing 31 changed files with 269 additions and 259 deletions.
13 changes: 9 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,28 @@ title: '[BUG]'
labels: 'kind/bug'
assignees: ''
---

**Description**

<!-- A brief description of the issue. -->

**Expected Behavior**

<!-- A brief description of what you expected to happen. -->

**Screenshots**

<!-- Add screenshots, if applicable, to help explain your problem. -->

**Environment:**
- Host OS:
- Browser:

---
- Host OS:
- Browser:

---

[Optional] **Additional Context**

<!-- Add any other context about the problem here. -->

---
---
8 changes: 7 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,23 @@ title: '[Feature Request]'
labels: 'kind/enhancement'
assignees: ''
---

**Current Behavior**

<!-- A brief description of what the problem is. (e.g. I need to be able to...) -->

**Desired Behavior**

<!-- A brief description of the enhancement. -->

---

**Screenshots / Mockups**

<!-- Add any other context or screenshots about the feature request here. -->

**Alternatives**

<!-- A brief description of any alternative solutions or features you've considered. -->

---
---
6 changes: 3 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
This PR fixes #

<!--
Thank you for contributing to Robyn!
Thank you for contributing to Robyn!
Contributing Conventions:
1. Include descriptive PR titles.
2. Build and test your changes before submitting a PR.
2. Build and test your changes before submitting a PR.
Pre-Commit Instructions:
Expand All @@ -21,4 +21,4 @@ You need to change the version number by appending the last digit for a test-pyp
e.g. if the current version of Robyn is `v0.18.1` the test deployment should be `v0.18.100001` (five zeroes as there are five characters in Robyn) and then an incremental digit.
Change the version number in `pyproject.yaml` and `Cargo.toml` to trigger a test deploy.
-->
-->
16 changes: 7 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@

**Closed issues:**

- \[Feature Request\] Add list of sponsors on the project website [\#182](https://github.com/sansyrox/robyn/issues/182)
- \[Feature Request\] Add list of sponsors on the project website [\#182](https://github.com/sansyrox/robyn/issues/182)
- Optional build feature for io\_uring [\#177](https://github.com/sansyrox/robyn/issues/177)
- Create Custom headers for the response. [\#174](https://github.com/sansyrox/robyn/issues/174)

Expand Down Expand Up @@ -169,7 +169,7 @@

**Closed issues:**

- Benchmarks to Björn, uvicorn etc. [\#142](https://github.com/sansyrox/robyn/issues/142)
- Benchmarks to Björn, uvicorn etc. [\#142](https://github.com/sansyrox/robyn/issues/142)
- Add Python linter setup [\#129](https://github.com/sansyrox/robyn/issues/129)
- Add fixtures in testing [\#84](https://github.com/sansyrox/robyn/issues/84)

Expand All @@ -180,11 +180,11 @@
**Closed issues:**

- Add PyPI classifiers [\#127](https://github.com/sansyrox/robyn/issues/127)
- Robyn version 0.9.0 doesn't work on Mac M1 Models [\#120](https://github.com/sansyrox/robyn/issues/120)
- Inconsistency in steps mentioned in Readme to run locally [\#119](https://github.com/sansyrox/robyn/issues/119)
- Robyn version 0.9.0 doesn't work on Mac M1 Models [\#120](https://github.com/sansyrox/robyn/issues/120)
- Inconsistency in steps mentioned in Readme to run locally [\#119](https://github.com/sansyrox/robyn/issues/119)
- Async web socket support [\#116](https://github.com/sansyrox/robyn/issues/116)
- Reveal Logo to be removed from Future Roadmap [\#107](https://github.com/sansyrox/robyn/issues/107)
- Dead Link for Test Drive Button on Robyn Landing Page [\#106](https://github.com/sansyrox/robyn/issues/106)
- Dead Link for Test Drive Button on Robyn Landing Page [\#106](https://github.com/sansyrox/robyn/issues/106)
- Add issue template, pr template and community guidelines [\#105](https://github.com/sansyrox/robyn/issues/105)
- For v0.7.0 [\#72](https://github.com/sansyrox/robyn/issues/72)
- Add better support for requests and response! [\#13](https://github.com/sansyrox/robyn/issues/13)
Expand Down Expand Up @@ -329,7 +329,7 @@

- Make html file serving more robust [\#45](https://github.com/sansyrox/robyn/issues/45)
- Try to serve individual static files using vanilla rust [\#43](https://github.com/sansyrox/robyn/issues/43)
- Error on import [\#16](https://github.com/sansyrox/robyn/issues/16)
- Error on import [\#16](https://github.com/sansyrox/robyn/issues/16)
- Add multiple process sharing [\#2](https://github.com/sansyrox/robyn/issues/2)

## [v0.5.0](https://github.com/sansyrox/robyn/tree/v0.5.0) (2021-07-01)
Expand Down Expand Up @@ -392,6 +392,4 @@

- Improve async runtime [\#3](https://github.com/sansyrox/robyn/issues/3)



\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
\* _This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)_
70 changes: 33 additions & 37 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
## Contributing Guidelines

First off, thank you for considering contributing to ```Robyn```. This guide details all the general information that one should know before contributing to the project.
Please stick as close as possible to the guidelines. That way we ensure that you have a smooth experience contributing to this project.
First off, thank you for considering contributing to `Robyn`. This guide details all the general information that one should know before contributing to the project.
Please stick as close as possible to the guidelines. That way, we ensure that you have a smooth experience contributing to this project.

### General Rules :
These are in general rules that you should be following while contributing to an Open Source project :
### General Rules:

These are, in general, rules that you should be following while contributing to an Open-Source project :

- Be Nice, Be Respectful (BNBR)
- Check if the Issue you created, exists or not.
- While creating a new issue make sure you describe the issue clearly.
- While creating a new issue, make sure you describe the issue clearly.
- Make proper commit messages and document your PR well.
- Always add Comments in your Code and explain it at points, if possible add Doctest.
- Always add comments in your Code and explain it at points if possible, add Doctest.
- Always create a Pull Request from a Branch; Never from the Main.
- Follow proper code conventions because writing clean code is important.
- Issues would be assigned on a "First Come, First Serve" basis.
- Do mention (@maintainer) the project maintainer if your PR isn't reviewed within few days.

## First time contributors :
- Issues would be assigned on a "First Come, First Served" basis.
- Do mention (@maintainer) the project maintainer if your PR isn't reviewed within a few days.

Pushing files in your own repository is easy but how to contribute to someone else's project? If you have the same question then below are the steps that you can follow
to make your first contribution in this repoitory.
## First time contributors:

Pushing files in your own repository is easy, but how to contribute to someone else's project? If you have the same question, then below are the steps that you can follow
to make your first contribution in this repository.

### Pull Request

**1.** The very first step includes forking the project. Click on the ```fork``` button as shown below to fork the project.
**1.** The very first step includes forking the project. Click on the `fork` button as shown below to fork the project.
<br><br><img src="https://i.imgur.com/7wapvt2.png" width="750" /><br>

**2.** Clone the forked repository. Open up the GitBash/Command Line and type
**2.** Clone the forked repository. Open up the GitBash/Command Line and type

```
git clone https://github.com/<YOUR_USER_NAME>/robyn.git
Expand All @@ -38,13 +38,14 @@ git clone https://github.com/<YOUR_USER_NAME>/robyn.git
```
cd robyn
```

**4.** Add a reference to the original repository.

```
git remote add upstream https://github.com/sansyrox/robyn.git
```

**5.** See latest changes to the repo using
**5.** See latest changes to the repo using

```
git remote -v
Expand All @@ -56,67 +57,62 @@ git remote -v
git checkout -b <YOUR_BRANCH_NAME>
```

**7.** Always take a pull from the upstream repository to your main branch to keep it even with the main project. This will save your from frequent merge conflicts.
**7.** Always take a pull from the upstream repository to your main branch to keep it even with the main project. This will save you from frequent merge conflicts.

```
git pull upstream main
```

**8.** You can make the required changes now. Make appropriate commits with proper commit messages.
**8.** You can make the required changes now. Make appropriate commits with proper commit messages.

**9.** Add and then commit your changes.

```
git add .
```

```
git commit -m "<YOUR_COMMIT_MESSAGE>"
```


**10.** Push your local branch to the remote repository.

```
git push -u origin <YOUR_BRANCH_NAME>
```

**11.** Once you have pushed the changes to your repository, go to your forked repository. Click on the ```Compare & pull request``` button as shown below.
**11.** Once you have pushed the changes to your repository, go to your forked repository. Click on the `Compare & pull request` button as shown below.
<br><br><img src="https://hisham.hm/img/posts/github-comparepr.png" width="750" /><br>


**12.** The image below is how the new page would look like. Give a proper title to your PR and describe the changes made by you in the description box.(Note - Sometimes there are PR templates which is to be filled as instructed.)
**12.** The image below is what the new page would look like. Give a proper title to your PR and describe the changes made by you in the description box.(Note - Sometimes there are PR templates which are to be filled as instructed.)
<br><br><img src="https://github.blog/wp-content/uploads/2019/02/draft-pull-requests.png?fit=1354%2C780" width="750" /><br>

**13.** Open a pull request by clicking the `Create pull request` button.

**13.** Open a pull request by clicking the ```Create pull request``` button.

```Voila, you have made your first contribution to this project```
`Voila, you have made your first contribution to this project`

## Issue
## Issue

- Issues can be used to keep track of bugs, enhancements, or other requests. Creating an issue to let the project maintainers know about the changes your are
planning to make before raising a PR is a good open source practice.
<br>
- Issues can be used to keep track of bugs, enhancements, or other requests. Creating an issue to let the project maintainers know about the changes you are planning to make before raising a PR is a good open-source practice.
<br>

Lets walkthrough the steps to create an issue:
Let's walk through the steps to create an issue:

**1.** On GitHub navigate to the main page of the repository. [Here](https://github.com/sansyrox/robyn.git) in this case.
**1.** On GitHub, navigate to the main page of the repository. [Here](https://github.com/sansyrox/robyn.git) in this case.


**2.** Under your repository name, click on the ```Issues``` button.
**2.** Under your repository name, click on the `Issues` button.
<br><br><img src="https://www.stevejgordon.co.uk/wp-content/uploads/2018/01/GitHubIssueTab.png" width="750" /><br>


**3.** Click on the ```New issue``` button.
**3.** Click on the `New issue` button.
<br><br><img src="https://miro.medium.com/max/3696/1*8jiGiKhMdVQDycWSAbjB8A.png" width="750" /><br>

**4.** Select one of the Issue Templates to get started.
<br><br><img src="https://i.imgur.com/xz2KAwU.png" width="750" /><br>

**4.** Fill in the appropriate ```Title``` and ```Issue description``` and click on ```Submit new issue```.
**4.** Fill in the appropriate `Title` and `Issue description` and click on `Submit new issue`.
<br><br><img src="https://i.imgur.com/XwjtGG1.png" width="750" /><br>

### Tutorials that may help you :
### Tutorials that may help you:

- [Git & GitHub Tutorial](https://www.youtube.com/watch?v=RGOj5yH7evk)
- [Resolve merge conflict](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)
- [Resolve merge conflict](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)
18 changes: 4 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

<img alt="Robyn Logo" src="https://user-images.githubusercontent.com/29942790/140995889-5d91dcff-3aa7-4cfb-8a90-2cddf1337dca.png" width="250" />

# Robyn
Expand All @@ -11,12 +10,10 @@
[![License](https://img.shields.io/badge/License-BSD_2.0-black)](#license)
[![Discord](https://img.shields.io/discord/999782964143603713?label=discord&logo=discord&logoColor=white&style=for-the-badge&color=blue)](https://discord.gg/rkERZ5eNU8)


[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](https://sansyrox.github.io/robyn/#/)

Robyn is a fast async Python web server with a runtime written in Rust.


Check out the talk at **PyCon Sweden 2021** about [Robyn: An async python web framework with a Rust runtime](https://www.youtube.com/watch?v=DK9teAs72Do)

## 📦 Installation
Expand All @@ -36,7 +33,6 @@ conda install -c conda-forge robyn
## 🤔 Usage

```python

from robyn import Robyn

app = Robyn(__file__)
Expand All @@ -46,10 +42,10 @@ async def h(request):
return "Hello, world!"

app.start(port=5000)

```

## 💡 Features

- Under active development!
- Written in Rust, btw xD
- A multithreaded Runtime
Expand All @@ -63,7 +59,6 @@ app.start(port=5000)
- Hot Reloading
- Community First and truly FOSS!


## 🗒️ Contributor Guidelines

Feel free to open an issue for any clarification or for any suggestions.
Expand All @@ -76,7 +71,7 @@ If you're feeling curious. You can take a look at a more detailed architecture [

1. Install the pre-commit git hooks: `pre-commit install`

1. Add more routes in the `integration_tests/base_routes.py` file(if you like).
1. Add more routes in the `integration_tests/base_routes.py` file (if you like).

1. Run `maturin develop` or `maturin develop --cargo-extra-args="--features=io-uring"` (if you want to run the experimental version).

Expand All @@ -99,7 +94,6 @@ optional arguments:
--log-level LEVEL : this flag allows you to set the log level
```


## ✨ Contributors/Supporters

To contribute to Robyn, make sure to first go through the [CONTRIBUTING.md](./CONTRIBUTING.md).
Expand All @@ -110,16 +104,12 @@ Thanks to all the contributors of the project. Robyn will not be what it is with
<img src="https://contrib.rocks/image?repo=sansyrox/robyn" />
</a>


Special thanks to the [ PyO3 ](https://pyo3.rs/v0.13.2/) community and [ Andrew from PyO3-asyncio ](https://github.com/awestlake87/pyo3-asyncio) for their amazing libraries and their support for my queries. 💖
Special thanks to the [PyO3](https://pyo3.rs/v0.13.2/) community and [Andrew from PyO3-asyncio](https://github.com/awestlake87/pyo3-asyncio) for their amazing libraries and their support for my queries. 💖

## ✨ Sponsors

These sponsors help us make the magic happen!

[![DigitalOcean Referral Badge](https://web-platforms.sfo2.cdn.digitaloceanspaces.com/WWW/Badge%201.svg)](https://www.digitalocean.com/?refcode=3f2b9fd4968d&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge)

- [ Shivay Lamba ](https://github.com/shivaylamba)



- [Shivay Lamba](https://github.com/shivaylamba)
Loading

0 comments on commit 69e1b8e

Please sign in to comment.