Skip to content

Commit 428cd89

Browse files
committed
Updated to suit uploading to PyPI.
* Put code in `src`. * Version as per PEP 440. * Added build directories to ignore file. * Updated README. * Created a makefile to upload releases.
1 parent fad8a5b commit 428cd89

File tree

7 files changed

+22
-7
lines changed

7 files changed

+22
-7
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
__pycache__
22
build
3+
dist
34
*.egg-info

Makefile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
SHELL = /bin/sh
2+
PYTHON = python3
3+
BUILD = $(PYTHON) -m build
4+
TWINE = $(PYTHON) -m twine
5+
6+
.PHONY: release release_test
7+
8+
release:
9+
$(BUILD)
10+
$(TWINE) upload dist/*
11+
12+
release_test:
13+
$(BUILD)
14+
$(TWINE) upload --repository testpypi dist/*

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Scrollable containers which *just work*:tm:!
1+
# Scrollable containers which *just work*!
22
If you have developed GUI applications, you probably know the pain of designing a clean front-end only to find that
33
your application window is too large for your client's screen. Making the content scrollable is not straightforward (at
44
least in Tkinter). Especially not after you have already written a lot of code to draw the content.
55

66
You can use `ScrollableContainers` to reduce headaches. Run the following command to install the package.
77

88
```shell
9-
pip install git+https://github.com/tfpf/ScrollableContainers.git
9+
pip install ScrollableContainers
1010
```
1111

1212
## `ScrollableFrameTk`
@@ -19,8 +19,8 @@ A full implementation of a scrollable frame in Tkinter.
1919
triggers a horizontal scroll.
2020

2121
### Usage
22-
Add widgets to the `frame` attribute of a `ScrollableFrameTk` object. See
23-
[`examples/examples_ScrollableFrameTk.py`](examples/examples_ScrollableFrameTk.py).
22+
Add widgets to the `frame` attribute of a `ScrollableFrameTk` object.
23+
[See examples.](https://github.com/tfpf/ScrollableContainers/blob/main/examples/examples_ScrollableFrameTk.py)
2424

2525
### Notes
2626
`'<Button-4>'`, `'<Button-5>'` and `'<MouseWheel>'` are bound to all widgets using `bind_all` to handle mouse wheel
@@ -32,5 +32,5 @@ A thin wrapper around `wx.lib.scrolledpanel.ScrolledPanel`.
3232
* Horizontally centres the contents if the window is wider.
3333

3434
### Usage
35-
Add widgets to the `panel` attribute of a `ScrollablePanelWx` object. See
36-
[`examples/examples_ScrollablePanelWx.py`](examples/examples_ScrollablePanelWx.py).
35+
Add widgets to the `panel` attribute of a `ScrollablePanelWx` object.
36+
[See examples.](https://github.com/tfpf/ScrollableContainers/blob/main/examples/examples_ScrollablePanelWx.py)

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ readme = "README.md"
1313
requires-python = ">=3.8"
1414
classifiers = [
1515
"Programming Language :: Python :: 3",
16-
"Licence :: OSI Approved :: MIT Licence",
16+
"License :: OSI Approved :: MIT License",
1717
"Operating System :: OS Independent",
1818
]
1919

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)