Skip to content

Commit

Permalink
feat: prepare Github/Gitlab files
Browse files Browse the repository at this point in the history
  • Loading branch information
MatteoGuadrini committed Sep 17, 2024
2 parents 6e505ac + f36ebf5 commit 55959ac
Show file tree
Hide file tree
Showing 4 changed files with 471 additions and 127 deletions.
4 changes: 4 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Release notes

## 0.0.7
Sep 17, 2024
- Add **prj_remote** function

## 0.0.6
Sep 06, 2024
- Add **prj_ci** function
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "psp"
version = "0.0.6"
version = "0.0.7"
edition = "2021"
authors = ["matteoguadrini <matteo.guadrini@hotmail.it>"]
description = "PSP (Python Scaffolding Projects)"
Expand Down
38 changes: 27 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@

```console
psp # Press Enter
Welcome to PSP (Python Scaffolding Projects): 0.0.6
Welcome to PSP (Python Scaffolding Projects): 0.0.7
> Name of Python project: test
> Do you want to start git repository? Yes
> Do you want unit test files? Yes
> Do you want to create a virtual environment? Yes
> Install dependencies: scipy numpy
> Select CI provider: CircleCI
> Select git remote provider: Github
> Username of Github: MatteoGuadrini
Project `test` created
```

The result is
The result is:

```console
tree test --filelimit=8 -a
Expand All @@ -36,6 +38,13 @@ test # project folder
│   └── refs
│   ├── heads
│   └── tags
├── .github # Github issue and merge templates
│   ├── ISSUE_TEMPLATE
│   │   ├── bug.yml
│   │   ├── config.yml
│   │   └── feature.yml
│   └── PULL_REQUEST_TEMPLATE
│   └── pull_request_template.md
├── .gitignore # git ignore file
├── test # python package
│   └── __init__.py
Expand Down Expand Up @@ -91,10 +100,10 @@ test # project folder
├── lib64 -> lib
└── pyvenv.cfg

33 directories, 39 files
36 directories, 43 files
```

> This project is WIP
> This project is WIP: beta
## Prerequisites

Expand All @@ -107,19 +116,26 @@ test # project folder

To install compiled file into your machine, download it:

### Linux

For all users:
```console
# For Linux (all users)
sudo -i
curl -L https://github.com/MatteoGuadrini/psp/releases/download/v0.0.6/psp_linux > /usr/bin/psp
curl -L https://github.com/MatteoGuadrini/psp/releases/download/v0.0.7/psp_linux > /usr/bin/psp
chmod +x /usr/bin/psp
```

# For Linux (current user)
curl -L https://github.com/MatteoGuadrini/psp/releases/download/v0.0.6/psp_linux > $HOME/.local/bin/psp
For current user:
```console
curl -L https://github.com/MatteoGuadrini/psp/releases/download/v0.0.7/psp_linux > $HOME/.local/bin/psp
chmod +x $HOME/.local/bin/psp
```

### MacOS

# For MacOS
```console
sudo su -
curl -L https://github.com/MatteoGuadrini/psp/releases/download/v0.0.6/psp_macos > /usr/bin/psp
curl -L https://github.com/MatteoGuadrini/psp/releases/download/v0.0.7/psp_macos > /usr/bin/psp
chmod +x /usr/bin/psp
```

Expand All @@ -139,7 +155,7 @@ cd psp && cargo build && sudo cp -var target/release/psp /usr/bin/psp
- [x] Install dependencies
- [x] Prepare pyproject.toml
- [x] Prepare CI configuration files
- [ ] Prepare Github/Gitlab files
- [x] Prepare Github/Gitlab files
- [ ] Prepare tox environment
- [ ] Prepare docs folder for sphinx/mkdocs documentation
- [ ] Prepare README, LICENSE, CONTRIBUTING, CODE_OF_CONDUCT and CHANGES files
Expand Down
Loading

0 comments on commit 55959ac

Please sign in to comment.