Skip to content

Commit e39dd01

Browse files
author
Bart Hazen
committed
Improve contribution guide and add some more texts to the frontend.
1 parent 4616399 commit e39dd01

File tree

7 files changed

+100
-11
lines changed

7 files changed

+100
-11
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
This document describes how the development of Python Create is organised.
4+
5+
6+
## Setting up the project
7+
8+
```bash
9+
npm install
10+
npm run start # Develop mode
11+
```
12+
13+
## Creating a new feature
14+
15+
If you're a member of this project, please create branches in the following format: `feature/PC{issue #}_short_title`.
16+
An example would be `feature/PC16_seo_improvement`.
17+
18+
## Going to production
19+
20+
Verify that the website still works after running the commands below.
21+
22+
```bash
23+
npm run build # Build source files
24+
firebase emulators:start # Emulate Firebase components locally
25+
```
26+
27+
Once this is fine, please create a [pull request](https://github.com/bartcode/pythoncreate/compare) and assign it to
28+
one of the contributors.

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11

22
# Python Create
33

4-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
4+
With [Python Create](https://pythoncreate.com/), we're aiming to create on online platform with generators (and perhaps some tutorials) for
5+
developing proper Python code. Feature suggestions can be submitted to the [Issues](https://github.com/bartcode/pythoncreate/issues)
6+
page of this repository.
57

6-
## Usage
8+
## FAQ
79

8-
```bash
9-
$ npm run build # Build source files
10-
$ npm run start # Develop mode
11-
$ firebase emulators:start # Emulate Firebase components locally
12-
```
10+
- **Why shouldn't I use Python packages that help set up my project?**
11+
12+
> You can.
13+
> However, sometimes it's a bit of an overkill to install a package that does some wizardous actions for you. With Python Create, we're trying to offer transparant tools that show you how your code changes based on your needs.
14+
15+
- **How come there are already frequently asked questions when this website hasn't been live for so long?**
16+
17+
> These are made up.
18+
19+
- **Can I contribute to this website?**
20+
21+
> [YES, PLEASE.](https://github.com/bartcode/pythoncreate/issues)
22+
23+
- **How can I contact these React losers?**
24+
25+
> In the unlikely event that anyone ever reads this, you can leave your love or hate speeches on the [Issues](https://github.com/bartcode/pythoncreate/issues) page.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"react": "^16.13.1",
1717
"react-copy-to-clipboard": "^5.0.2",
1818
"react-dom": "^16.13.1",
19-
"react-helmet": "^6.0.0",
19+
"react-helmet": "^6.1.0",
2020
"react-markdown": "^4.3.1",
2121
"react-router-dom": "^5.1.2",
2222
"react-scripts": "3.4.1",

src/pages/Homepage/Homepage.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,34 @@ where we'll introduce you our one and only super helpful generator for `setup.py
55

66
This website has been developed by Python-enthusiasts, lacking of serious web development skills,
77
yet wanting to experiment a bit with React.
8+
9+
## Future plans
10+
11+
The current content is just the beginning, and we're aiming for creating more useful generators we ourselves
12+
frequently need as well to finally get satisfactory answers to questions for creating:
13+
14+
- a `pyproject.toml` file,
15+
- pre-commit hooks,
16+
- and a Docker image to run your Python project.
17+
18+
We're open to suggestions. Please submit issues you find or feature suggestions to our
19+
[GitHub repository](https://github.com/bartcode/pythoncreate/issues).
20+
21+
## FAQ
22+
23+
- **Why shouldn't I use Python packages that help set up my project?**
24+
25+
> You can.
26+
> However, sometimes it's a bit of an overkill to install a package that does some wizardous actions for you. With Python Create, we're trying to offer transparant tools that show you how your code changes based on your needs.
27+
28+
- **How come there are already frequently asked questions when this website hasn't been live for so long?**
29+
30+
> These are made up.
31+
32+
- **Can I contribute to this website?**
33+
34+
> [YES, PLEASE.](https://github.com/bartcode/pythoncreate/issues)
35+
36+
- **How can I contact these React losers?**
37+
38+
> In the unlikely event that anyone ever reads this, you can leave your love or hate speeches on the [Issues](https://github.com/bartcode/pythoncreate/issues) page.

src/pages/Homepage/index.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import ReactMarkdown from 'react-markdown'
44
import { Paper } from "@material-ui/core";
55
import markdownSource from "pages/Homepage/Homepage.md"
66
import Header from "components/Header";
7+
import { Helmet } from "react-helmet";
78

89
export default class Homepage extends React.Component {
910
constructor(props) {
@@ -22,6 +23,11 @@ export default class Homepage extends React.Component {
2223
return (
2324
<React.Fragment>
2425
<Header onDrawerToggle={this.props.handleDrawerToggle} />
26+
<Helmet>
27+
<title>Homepage | Python Create</title>
28+
<meta name="description" content="Python Create offers generators and instructions on using Python optimally. Get help writing your code by the tools we offer." />
29+
<meta name="robots" content="index, follow" />
30+
</Helmet>
2531
<main className={this.props.classes.main}>
2632
<Paper className={this.props.classes.paper}>
2733
<div className={this.props.classes.contentWrapper}>

src/pages/SetupPy/SetupPy-intro.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# `setup.py` generator
22

3-
Setting up your project with a proper `setup.py` can be a pain in the buttocks. This tool
4-
helps you to get started with your Python project.
3+
Setting up your project with a proper `setup.py` can be a pain in the buttocks. Especially
4+
when you really, _really_, want to distribute your package to more users than just your dog and two cats.
5+
This tool helps you to get over the big hurdle of publishing a useful tool for co-Python-nerds.
6+
7+
Using the switches below, this tool transparantly shows you what needs to change in your `setup.py`
8+
file to get what you want. Even if you've already almost finished your own code, this might _just_ answer
9+
the question how you can include package data, classifiers, or even where to store the version of your package.

src/pages/SetupPy/index.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import { CopyToClipboard } from 'react-copy-to-clipboard';
1111
import markdownSourceIntro from "pages/SetupPy/SetupPy-intro.md"
1212
import pythonClassifiers from "pages/SetupPy/classifiers.json"
1313
import Header from "components/Header";
14+
import { Helmet } from "react-helmet";
1415

1516

1617

@@ -80,7 +81,7 @@ export default class SetupPy extends React.Component {
8081
}
8182

8283
if (this.state.versionInPackage) {
83-
code.push(` version=VERSION.get("__version__", None),`);
84+
code.push(` version=VERSION.get("__version__", "0.0.0"),`);
8485
} else if (this.state.version) {
8586
code.push(` version="` + this.state.version + `",`);
8687
}
@@ -168,6 +169,11 @@ export default class SetupPy extends React.Component {
168169
return (
169170
<React.Fragment>
170171
<Header onDrawerToggle={this.props.handleDrawerToggle} />
172+
<Helmet>
173+
<title>setup.py generator for Python projects | Python Create</title>
174+
<meta name="description" content="Use the setup.py generator to get perfect the way you're installing your Python package." />
175+
<meta name="robots" content="index, follow" />
176+
</Helmet>
171177
<main className={this.props.classes.main}>
172178
<Paper className={this.props.classes.paper}>
173179
<div className={this.props.classes.contentWrapper}>

0 commit comments

Comments
 (0)