Skip to content

Commit ab75433

Browse files
authored
remove python version completely (#573)
* drop python version * clean up docs and help
1 parent b43e06d commit ab75433

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+46
-6038
lines changed

.github/dependabot.yml

-5
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,3 @@ updates:
1717
directory: "/"
1818
schedule:
1919
interval: "weekly"
20-
21-
- package-ecosystem: "pip"
22-
directory: "/"
23-
schedule:
24-
interval: "weekly"

.gitignore

+5-14
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,12 @@
1-
.eggs
2-
*egg-info
3-
*.pyc
4-
venvbuild
5-
dist
6-
venv
7-
.venv
8-
.venv-*
9-
.coverage
101
htmlcov/
11-
build/
122
reckoner/version.txt
133
installer/reckoner.spec
144
node_modules
15-
/dist
16-
/bin
17-
185
coverage.txt
19-
/reckoner-go
206
cover-report.html
217
govet-report.out
8+
9+
/bin
10+
/build
11+
/dist
12+
/reckoner-go

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# DEPRECATED - See the releases page for the changelog
1+
# **DEPRECATED - See the releases page for the changelog**
22

33

44
# Changelog

README.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,9 @@ Check out the [documentation at docs.fairwinds.com](https://reckoner.docs.fairwi
2121

2222
## Requirements
2323

24-
* python 3
2524
* helm (>= 3.0.0), installed and initialized
2625

27-
*Note:* Python2 is no longer supported by Reckoner.
28-
*Note2:* Helm2 support will not be tested from v4.3.0. The maintainers have [deprecated helm2](https://helm.sh/blog/helm-v2-deprecation-timeline/).
29-
30-
### Installation
31-
32-
* `pip install reckoner`
26+
> Helm2 is untested as of v4.3.0. The maintainers of helm have [deprecated helm2](https://helm.sh/blog/helm-v2-deprecation-timeline/).
3327
3428
## Quickstart
3529

@@ -61,7 +55,7 @@ Grafana and Polaris should now be installed on your cluster!
6155

6256
## Importing Existing Releases
6357

64-
Warning: Experimental
58+
> Importing existing releases is experimental and the result should be reviewed.
6559
6660
If you're already using Helm but want to start using `reckoner`, you can use `reckoner import` to facilitate your migration.
6761

cmd/root.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ var lintCmd = &cobra.Command{
270270
var convertCmd = &cobra.Command{
271271
Use: "convert",
272272
Short: "convert <course file>",
273-
Long: "Converts a course file from the v1 python schema to v2 go schema",
273+
Long: "Converts a course file from the v1 schema to v2 schema (reckoner v6.0.0+)",
274274
PreRunE: func(cmd *cobra.Command, args []string) error {
275275
runAll = true
276276
return validateCobraArgs(cmd, args)

development-requirements.txt

-6
This file was deleted.

docs/README.md

+29-11
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,14 @@ This utility adds to the functionality of [Helm](https://github.com/kubernetes/h
1616
* Creates a declarative syntax to manage multiple releases in one place
1717
* Allows installation of charts from a git commit/branch/release
1818

19-
**Want to learn more?** Reach out on [the Slack channel](https://fairwindscommunity.slack.com/messages/reckoner) ([request invite](https://join.slack.com/t/fairwindscommunity/shared_invite/zt-e3c6vj4l-3lIH6dvKqzWII5fSSFDi1g)), send an email to `[email protected]`, or join us for [office hours on Zoom](https://fairwindscommunity.slack.com/messages/office-hours)
20-
19+
# Documentation
20+
Check out the [documentation at docs.fairwinds.com](https://reckoner.docs.fairwinds.com/)
2121

2222
## Requirements
2323

24-
* python 3
2524
* helm (>= 3.0.0), installed and initialized
2625

27-
*Note:* Python2 is no longer supported by Reckoner.
28-
*Note2:* Helm2 support will not be tested from v4.3.0. The maintainers have [deprecated helm2](https://helm.sh/blog/helm-v2-deprecation-timeline/).
29-
30-
### Installation
31-
32-
* `pip install reckoner`
26+
> Helm2 is untested as of v4.3.0. The maintainers of helm have [deprecated helm2](https://helm.sh/blog/helm-v2-deprecation-timeline/).
3327
3428
## Quickstart
3529

@@ -59,10 +53,34 @@ reckoner plot course.yml --run-all
5953

6054
Grafana and Polaris should now be installed on your cluster!
6155

62-
## Adopting Reckoner
56+
## Importing Existing Releases
6357

64-
Warning: Experimental
58+
> Importing existing releases is experimental and the result should be reviewed.
6559
6660
If you're already using Helm but want to start using `reckoner`, you can use `reckoner import` to facilitate your migration.
6761

6862
We recommend carefully examining the output of a `reckoner diff` before relying on any imported course.yml definitions.
63+
64+
<!-- Begin boilerplate -->
65+
## Join the Fairwinds Open Source Community
66+
67+
The goal of the Fairwinds Community is to exchange ideas, influence the open source roadmap,
68+
and network with fellow Kubernetes users.
69+
[Chat with us on Slack](https://join.slack.com/t/fairwindscommunity/shared_invite/zt-e3c6vj4l-3lIH6dvKqzWII5fSSFDi1g)
70+
or
71+
[join the user group](https://www.fairwinds.com/open-source-software-user-group) to get involved!
72+
73+
<a href="https://www.fairwinds.com/t-shirt-offer?utm_source=reckoner&utm_medium=reckoner&utm_campaign=reckoner-tshirt">
74+
<img src="https://www.fairwinds.com/hubfs/Doc_Banners/Fairwinds_OSS_User_Group_740x125_v6.png" alt="Love Fairwinds Open Source? Share your business email and job title and we'll send you a free Fairwinds t-shirt!" />
75+
</a>
76+
77+
## Other Projects from Fairwinds
78+
79+
Enjoying Reckoner? Check out some of our other projects:
80+
* [Polaris](https://github.com/FairwindsOps/Polaris) - Audit, enforce, and build policies for Kubernetes resources, including over 20 built-in checks for best practices
81+
* [Goldilocks](https://github.com/FairwindsOps/Goldilocks) - Right-size your Kubernetes Deployments by compare your memory and CPU settings against actual usage
82+
* [Pluto](https://github.com/FairwindsOps/Pluto) - Detect Kubernetes resources that have been deprecated or removed in future versions
83+
* [Nova](https://github.com/FairwindsOps/Nova) - Check to see if any of your Helm charts have updates available
84+
* [rbac-manager](https://github.com/FairwindsOps/rbac-manager) - Simplify the management of RBAC in your Kubernetes clusters
85+
86+
Or [check out the full list](https://www.fairwinds.com/open-source-software?utm_source=reckoner&utm_medium=reckoner&utm_campaign=reckoner)

docs/contributing/guide.md

+8-21
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,21 @@ meta:
88

99
## Installation for Local Development
1010

11-
Requirements
12-
* Python 3
13-
* pip
11+
Requirements:
12+
* [Go](https://go.dev)
1413

15-
```shell
16-
%> python -V # Check your version of python
17-
%> python -m venv venv # setup a virtual env in your cloned repo
18-
%> source ./venv/bin/activate # use the virtual env
19-
(venv) %> pip install -e . # Installs reckoner as locally linked folders
20-
(venv) %> reckoner --version # Check the version you're running in the virtualenv
14+
```sh
15+
$ go --version # Check your version of golang
16+
$ go mod tidy # get dependencies
17+
$ go run . --help # compile & run the project
2118
```
22-
Note that some of the above commands may need `python3` instead of just `python` to work depending on your environment.
23-
24-
*Note:* Python2 is no longer supported by this tool
2519

2620
## Requirements for Pull Requests
2721
* Update the changelog
2822
* Run tests
2923
* Suggest version bump type
3024

3125
## How to run tests and test coverage
32-
```bash
33-
>> pip install -r development-requirements.txt
34-
>> pytest
35-
```
36-
37-
With Coverage Reports
38-
```bash
39-
>> pytest --cov reckoner/ --cov-report=html #shows an html line coverage report in ./htmlcov/
40-
>> pytest --cov reckoner/ --cov-report=term #shows terminal coverage report of % coverage
26+
```sh
27+
$ go test ./...
4128
```

end_to_end_testing/pre_python.sh

-3
This file was deleted.

end_to_end_testing/run_python.sh

-25
This file was deleted.

reckoner/__init__.py

-13
This file was deleted.

0 commit comments

Comments
 (0)