Skip to content

Commit 4b20233

Browse files
authored
Change project lead to Roland Walker.
Update contributing instructions.
1 parent 27a0f2f commit 4b20233

File tree

6 files changed

+17
-59
lines changed

6 files changed

+17
-59
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44

55

66
## Checklist
7-
<!--- We appreciate your help and want to give you credit. Please take a moment to put an `x` in the boxes below as you complete them. -->
7+
<!--- We appreciate your help and want to give you credit. Place an `x` in the boxes below as you complete them. -->
88
- [ ] I've added this contribution to the `changelog.md`.
99
- [ ] I've added my name to the `AUTHORS` file (or it's already there).

CONTRIBUTING.md

Lines changed: 6 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,20 @@ You'll always get credit for your work.
1919
$ git remote add upstream [email protected]:dbcli/mycli.git
2020
```
2121

22-
4. Set up a [virtual environment](http://docs.python-guide.org/en/latest/dev/virtualenvs)
22+
4. Set up a [uv](https://docs.astral.sh/uv/getting-started/installation/)
2323
for development:
2424

2525
```bash
2626
$ cd mycli
27-
$ pip install virtualenv
28-
$ virtualenv mycli_dev
27+
$ uv venv
2928
```
3029

3130
We've just created a virtual environment that we'll use to install all the dependencies
3231
and tools we need to work on mycli. Whenever you want to work on mycli, you
3332
need to activate the virtual environment:
3433

3534
```bash
36-
$ source mycli_dev/bin/activate
35+
$ source ./bin/activate
3736
```
3837

3938
When you're done working, you can deactivate the virtual environment:
@@ -45,8 +44,8 @@ You'll always get credit for your work.
4544
5. Install the dependencies and development tools:
4645
4746
```bash
48-
$ pip install -r requirements-dev.txt
49-
$ pip install --editable .
47+
$ uv pip install -r requirements-dev.txt
48+
$ uv pip install --editable .
5049
```
5150
5251
6. Create a branch for your bugfix or feature based off the `main` branch:
@@ -76,18 +75,10 @@ You'll always get credit for your work.
7675
While you work on mycli, it's important to run the tests to make sure your code
7776
hasn't broken any existing functionality. To run the tests, just type in:
7877
79-
```bash
80-
$ ./setup.py test
81-
```
82-
83-
Mycli supports Python 2.7 and 3.4+. You can test against multiple versions of
84-
Python by running tox:
85-
8678
```bash
8779
$ tox
8880
```
8981
90-
9182
### Test Database Credentials
9283
9384
The tests require a database connection to work. You can tell the tests which
@@ -126,42 +117,6 @@ $ readlink -f $(which ex)
126117
```
127118
128119
129-
## Coding Style
130-
131-
Mycli requires code submissions to adhere to
132-
[PEP 8](https://www.python.org/dev/peps/pep-0008/).
133-
It's easy to check the style of your code, just run:
134-
135-
```bash
136-
$ ./setup.py lint
137-
```
138-
139-
If you see any PEP 8 style issues, you can automatically fix them by running:
140-
141-
```bash
142-
$ ./setup.py lint --fix
143-
```
144-
145-
Be sure to commit and push any PEP 8 fixes.
146-
147120
## Releasing a new version of mycli
148121
149-
You have been made the maintainer of `mycli`? Congratulations! We have a release script to help you:
150-
151-
```sh
152-
> python release.py --help
153-
Usage: release.py [options]
154-
155-
Options:
156-
-h, --help show this help message and exit
157-
-c, --confirm-steps Confirm every step. If the step is not confirmed, it
158-
will be skipped.
159-
-d, --dry-run Print out, but not actually run any steps.
160-
```
161-
162-
To release a new version of the package:
163-
164-
* Create and merge a PR to bump the version in the changelog ([example PR](https://github.com/dbcli/mycli/pull/1043)).
165-
* Pull `main` and bump the version number inside `mycli/__init__.py`. Do not check in - the release script will do that.
166-
* Make sure you have the dev requirements installed: `pip install -r requirements-dev.txt -U --upgrade-strategy only-if-needed`.
167-
* Finally, run the release script: `python release.py`.
122+
Create a new [release](https://github.com/dbcli/mycli/releases) in Github. This will trigger a Github action which will run all the tests, build the wheel and upload it to PyPI.

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -147,13 +147,10 @@ get this running in a development setup.
147147

148148
https://github.com/dbcli/mycli/blob/main/CONTRIBUTING.md
149149

150-
Please feel free to reach out to me if you need help.
151150

152-
151+
## Additional Install Instructions:
153152

154-
Twitter: [@amjithr](http://twitter.com/amjithr)
155-
156-
## Detailed Install Instructions:
153+
These are some alternative ways to install mycli that are not managed by our team but provided by OS package maintainers. These packages could be slightly out of date and take time to release the latest version.
157154

158155
### Arch, Manjaro
159156

@@ -202,7 +199,7 @@ Thanks to [PyMysql](https://github.com/PyMySQL/PyMySQL) for a pure python adapte
202199

203200
### Compatibility
204201

205-
Mycli is tested on macOS and Linux, and requires Python 3.7 or better.
202+
Mycli is tested on macOS and Linux, and requires Python 3.9 or better.
206203

207204
**Mycli is not tested on Windows**, but the libraries used in this app are Windows-compatible.
208205
This means it should work without any modifications. If you're unable to run it

changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Features
99
Internal
1010
--------
1111

12+
* New Project Lead: [Roland Walker](https://github.com/rolandwalker)
1213
* Update sqlparse to <=0.6.0
1314
* Typing/lint fixes.
1415

mycli/AUTHORS

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
Project Lead:
2+
-------------
3+
4+
* Roland Walker
5+
16
Core Developers:
27
----------------
38

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "mycli"
33
dynamic = ["version"]
44
description = "CLI for MySQL Database. With auto-completion and syntax highlighting."
55
readme = "README.md"
6-
requires-python = ">=3.7"
6+
requires-python = ">=3.9"
77
license = { text = "BSD" }
88
authors = [{ name = "Mycli Core Team", email = "[email protected]" }]
99
urls = { homepage = "http://mycli.net" }

0 commit comments

Comments
 (0)