Skip to content

Commit 003d7cb

Browse files
committed
initialize the project
0 parents  commit 003d7cb

File tree

13 files changed

+451
-0
lines changed

13 files changed

+451
-0
lines changed

.github/workflows/build.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Build
2+
3+
on: [push]
4+
5+
env:
6+
CARGO_TERM_COLOR: always
7+
8+
jobs:
9+
build:
10+
name: 🔨Build release
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: 🔨Build release
15+
run: cargo build --release
16+
17+
package:
18+
name: 📦Check package generation
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v2
22+
- name: 📦Check package generation
23+
run: cargo package

.github/workflows/docs.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Docs
2+
3+
on: [push]
4+
5+
env:
6+
CARGO_TERM_COLOR: always
7+
8+
jobs:
9+
docs:
10+
name: 📄Build docs
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: 📄Build docs
15+
run: cargo doc --verbose

.github/workflows/package.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Package
2+
3+
on: [push]
4+
5+
env:
6+
CARGO_TERM_COLOR: always
7+
8+
jobs:
9+
# license:
10+
# name: 🏫License check
11+
# runs-on: ubuntu-latest
12+
# steps:
13+
# - uses: actions/checkout@v2
14+
# - name: 🏫Check license
15+
# run: |
16+
# cargo install cargo-deny
17+
# cargo deny check
18+
19+
package:
20+
name: 🔨Package
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v2
24+
- name: 🔨Check package build
25+
run: cargo package --verbose
26+
27+
cargo_check:
28+
name: 📦Check package integrity
29+
runs-on: ubuntu-latest
30+
steps:
31+
- uses: actions/checkout@v2
32+
- name: 📦Check package integrity
33+
run: cargo check --verbose
34+
35+
publish_dry_run:
36+
name: 📢Publish dry-run
37+
runs-on: ubuntu-latest
38+
steps:
39+
- uses: actions/checkout@v2
40+
- name: 📢Publish dry run
41+
run: cargo publish --dry-run --verbose
42+
43+
# dummy_publish:
44+
# name: 📦⬆️📢Publish dummy
45+
# # needs: [license, package, cargo_check, publish_dry_run]
46+
# needs: [package, cargo_check, publish_dry_run]
47+
# runs-on: ubuntu-latest
48+
# steps:
49+
# - uses: actions/checkout@v2
50+
# - name: 📦⬆️📢Publish dry run
51+
# run: cargo publish --dry-run --verbose

.github/workflows/rust.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Code check
2+
3+
on: [push]
4+
5+
env:
6+
CARGO_TERM_COLOR: always
7+
8+
jobs:
9+
code_check:
10+
name: 👔✒️Formatting and Linting
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: 👔Check Formatting
15+
run: cargo fmt -- --verbose --check --color auto
16+
- name: ✒️Check linting
17+
run: |
18+
rustup component add clippy
19+
set env RUSTFLAGS="-Dwarnings"
20+
cargo clippy --workspace -- -D warnings

.github/workflows/tests.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Tests
2+
3+
on: [push]
4+
5+
env:
6+
CARGO_TERM_COLOR: always
7+
8+
jobs:
9+
test:
10+
name: 🧪Run tests
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: 🧪Run tests
15+
run: cargo test --verbose

.gitignore

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
# Created by https://www.toptal.com/developers/gitignore/api/rust
3+
# Edit at https://www.toptal.com/developers/gitignore?templates=rust
4+
5+
### Rust ###
6+
# Generated by Cargo
7+
# will have compiled files and executables
8+
debug/
9+
target/
10+
11+
# Cargo.lock should be only added to binary crates
12+
13+
Cargo.lock
14+
15+
16+
# These are backup files generated by rustfmt
17+
**/*.rs.bk
18+
19+
# MSVC Windows builds of rustc generate these, which store debugging information
20+
*.pdb
21+
22+
# End of https://www.toptal.com/developers/gitignore/api/rust
23+
24+
# IntelliJ
25+
.idea/
26+
27+
# Visual Studio Code
28+
.vscode/
29+
workspace.code-workspace
30+
31+
# macOS
32+
.DS_Store

.rustfmt.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
max_width = 88
2+
ignore = ["."] # rustfmt does a poor job, and I don't want it ruining well-formatted code

Cargo.toml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[package]
2+
name = "rust-pip"
3+
version = "0.0.1"
4+
edition = "2021"
5+
description = "WORK IN PROGRESS: Pip rewritten in Rust"
6+
authors = [
7+
"Jan Bronicki janbronicki@gmail.com",
8+
]
9+
10+
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
11+
12+
[dependencies]
13+
14+
15+
[dev-dependencies]

LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2022, Jan Bronicki
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

Makefile.toml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[tasks.all]
2+
dependencies = ["format", "build", "clippy", "test", "doc"]
3+
4+
[tasks.format]
5+
install_crate = "rustfmt"
6+
command = "cargo"
7+
args = ["fmt", "--", "--emit=files"]
8+
9+
[tasks.clean]
10+
command = "cargo"
11+
args = ["clean"]
12+
13+
[tasks.build]
14+
command = "cargo"
15+
args = ["build"]
16+
dependencies = ["clean"]
17+
18+
[tasks.clippy]
19+
command = "cargo"
20+
args = ["clippy"]
21+
dependencies = ["clean"]
22+
23+
[tasks.test]
24+
command = "cargo"
25+
args = ["test"]
26+
dependencies = ["clean"]
27+
28+
[tasks.doc]
29+
command = "cargo"
30+
args = ["doc"]
31+
dependencies = ["clean"]

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# rust-pip
2+
3+
WORK IN PROGRESS
4+
Pip rewritten in Rust
5+
6+
## Features
7+
8+
* TODO
9+
10+
## Credits
11+
12+
This package was created with Cookiecutter, and the
13+
`John15321/cookiecutter-krabby-patty` project template.
14+
15+
Cookiecutter: <https://github.com/audreyr/cookiecutter>
16+
17+
`John15321/cookiecutter-krabby-patty`: <https://github.com/John15321/cookiecutter-krabby-patty>

0 commit comments

Comments
 (0)