Skip to content

Commit

Permalink
remove python version completely (#573)
Browse files Browse the repository at this point in the history
* drop python version

* clean up docs and help
  • Loading branch information
intrand authored Apr 25, 2022
1 parent b43e06d commit ab75433
Show file tree
Hide file tree
Showing 61 changed files with 46 additions and 6,038 deletions.
5 changes: 0 additions & 5 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,3 @@ updates:
directory: "/"
schedule:
interval: "weekly"

- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
19 changes: 5 additions & 14 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,21 +1,12 @@
.eggs
*egg-info
*.pyc
venvbuild
dist
venv
.venv
.venv-*
.coverage
htmlcov/
build/
reckoner/version.txt
installer/reckoner.spec
node_modules
/dist
/bin

coverage.txt
/reckoner-go
cover-report.html
govet-report.out

/bin
/build
/dist
/reckoner-go
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DEPRECATED - See the releases page for the changelog
# **DEPRECATED - See the releases page for the changelog**


# Changelog
Expand Down
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,9 @@ Check out the [documentation at docs.fairwinds.com](https://reckoner.docs.fairwi

## Requirements

* python 3
* helm (>= 3.0.0), installed and initialized

*Note:* Python2 is no longer supported by Reckoner.
*Note2:* Helm2 support will not be tested from v4.3.0. The maintainers have [deprecated helm2](https://helm.sh/blog/helm-v2-deprecation-timeline/).

### Installation

* `pip install reckoner`
> Helm2 is untested as of v4.3.0. The maintainers of helm have [deprecated helm2](https://helm.sh/blog/helm-v2-deprecation-timeline/).
## Quickstart

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

## Importing Existing Releases

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

Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ var lintCmd = &cobra.Command{
var convertCmd = &cobra.Command{
Use: "convert",
Short: "convert <course file>",
Long: "Converts a course file from the v1 python schema to v2 go schema",
Long: "Converts a course file from the v1 schema to v2 schema (reckoner v6.0.0+)",
PreRunE: func(cmd *cobra.Command, args []string) error {
runAll = true
return validateCobraArgs(cmd, args)
Expand Down
6 changes: 0 additions & 6 deletions development-requirements.txt

This file was deleted.

40 changes: 29 additions & 11 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,14 @@ This utility adds to the functionality of [Helm](https://github.com/kubernetes/h
* Creates a declarative syntax to manage multiple releases in one place
* Allows installation of charts from a git commit/branch/release

**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)

# Documentation
Check out the [documentation at docs.fairwinds.com](https://reckoner.docs.fairwinds.com/)

## Requirements

* python 3
* helm (>= 3.0.0), installed and initialized

*Note:* Python2 is no longer supported by Reckoner.
*Note2:* Helm2 support will not be tested from v4.3.0. The maintainers have [deprecated helm2](https://helm.sh/blog/helm-v2-deprecation-timeline/).

### Installation

* `pip install reckoner`
> Helm2 is untested as of v4.3.0. The maintainers of helm have [deprecated helm2](https://helm.sh/blog/helm-v2-deprecation-timeline/).
## Quickstart

Expand Down Expand Up @@ -59,10 +53,34 @@ reckoner plot course.yml --run-all

Grafana and Polaris should now be installed on your cluster!

## Adopting Reckoner
## Importing Existing Releases

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

We recommend carefully examining the output of a `reckoner diff` before relying on any imported course.yml definitions.

<!-- Begin boilerplate -->
## Join the Fairwinds Open Source Community

The goal of the Fairwinds Community is to exchange ideas, influence the open source roadmap,
and network with fellow Kubernetes users.
[Chat with us on Slack](https://join.slack.com/t/fairwindscommunity/shared_invite/zt-e3c6vj4l-3lIH6dvKqzWII5fSSFDi1g)
or
[join the user group](https://www.fairwinds.com/open-source-software-user-group) to get involved!

<a href="https://www.fairwinds.com/t-shirt-offer?utm_source=reckoner&utm_medium=reckoner&utm_campaign=reckoner-tshirt">
<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!" />
</a>

## Other Projects from Fairwinds

Enjoying Reckoner? Check out some of our other projects:
* [Polaris](https://github.com/FairwindsOps/Polaris) - Audit, enforce, and build policies for Kubernetes resources, including over 20 built-in checks for best practices
* [Goldilocks](https://github.com/FairwindsOps/Goldilocks) - Right-size your Kubernetes Deployments by compare your memory and CPU settings against actual usage
* [Pluto](https://github.com/FairwindsOps/Pluto) - Detect Kubernetes resources that have been deprecated or removed in future versions
* [Nova](https://github.com/FairwindsOps/Nova) - Check to see if any of your Helm charts have updates available
* [rbac-manager](https://github.com/FairwindsOps/rbac-manager) - Simplify the management of RBAC in your Kubernetes clusters

Or [check out the full list](https://www.fairwinds.com/open-source-software?utm_source=reckoner&utm_medium=reckoner&utm_campaign=reckoner)
29 changes: 8 additions & 21 deletions docs/contributing/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,21 @@ meta:

## Installation for Local Development

Requirements
* Python 3
* pip
Requirements:
* [Go](https://go.dev)

```shell
%> python -V # Check your version of python
%> python -m venv venv # setup a virtual env in your cloned repo
%> source ./venv/bin/activate # use the virtual env
(venv) %> pip install -e . # Installs reckoner as locally linked folders
(venv) %> reckoner --version # Check the version you're running in the virtualenv
```sh
$ go --version # Check your version of golang
$ go mod tidy # get dependencies
$ go run . --help # compile & run the project
```
Note that some of the above commands may need `python3` instead of just `python` to work depending on your environment.

*Note:* Python2 is no longer supported by this tool

## Requirements for Pull Requests
* Update the changelog
* Run tests
* Suggest version bump type

## How to run tests and test coverage
```bash
>> pip install -r development-requirements.txt
>> pytest
```

With Coverage Reports
```bash
>> pytest --cov reckoner/ --cov-report=html #shows an html line coverage report in ./htmlcov/
>> pytest --cov reckoner/ --cov-report=term #shows terminal coverage report of % coverage
```sh
$ go test ./...
```
3 changes: 0 additions & 3 deletions end_to_end_testing/pre_python.sh

This file was deleted.

25 changes: 0 additions & 25 deletions end_to_end_testing/run_python.sh

This file was deleted.

13 changes: 0 additions & 13 deletions reckoner/__init__.py

This file was deleted.

Loading

0 comments on commit ab75433

Please sign in to comment.