pipxclip 4.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2 @@
1
+ *.gif filter=lfs diff=lfs merge=lfs -text
2
+ *.webp filter=lfs diff=lfs merge=lfs -text
@@ -0,0 +1,220 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ *.lcov
51
+ .hypothesis/
52
+ .pytest_cache/
53
+ cover/
54
+
55
+ # Translations
56
+ *.mo
57
+ *.pot
58
+
59
+ # Django stuff:
60
+ *.log
61
+ local_settings.py
62
+ db.sqlite3
63
+ db.sqlite3-journal
64
+
65
+ # Flask stuff:
66
+ instance/
67
+ .webassets-cache
68
+
69
+ # Scrapy stuff:
70
+ .scrapy
71
+
72
+ # Sphinx documentation
73
+ docs/_build/
74
+
75
+ # PyBuilder
76
+ .pybuilder/
77
+ target/
78
+
79
+ # Jupyter Notebook
80
+ .ipynb_checkpoints
81
+
82
+ # IPython
83
+ profile_default/
84
+ ipython_config.py
85
+
86
+ # pyenv
87
+ # For a library or package, you might want to ignore these files since the code is
88
+ # intended to run in multiple environments; otherwise, check them in:
89
+ # .python-version
90
+
91
+ # pipenv
92
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
94
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
95
+ # install all needed dependencies.
96
+ # Pipfile.lock
97
+
98
+ # UV
99
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
100
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
101
+ # commonly ignored for libraries.
102
+ # uv.lock
103
+
104
+ # poetry
105
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
106
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
107
+ # commonly ignored for libraries.
108
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
109
+ # poetry.lock
110
+ # poetry.toml
111
+
112
+ # pdm
113
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
114
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
115
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
116
+ # pdm.lock
117
+ # pdm.toml
118
+ .pdm-python
119
+ .pdm-build/
120
+
121
+ # pixi
122
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
123
+ # pixi.lock
124
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
125
+ # in the .venv directory. It is recommended not to include this directory in version control.
126
+ .pixi/*
127
+ !.pixi/config.toml
128
+
129
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
130
+ __pypackages__/
131
+
132
+ # Celery stuff
133
+ celerybeat-schedule*
134
+ celerybeat.pid
135
+
136
+ # Redis
137
+ *.rdb
138
+ *.aof
139
+ *.pid
140
+
141
+ # RabbitMQ
142
+ mnesia/
143
+ rabbitmq/
144
+ rabbitmq-data/
145
+
146
+ # ActiveMQ
147
+ activemq-data/
148
+
149
+ # SageMath parsed files
150
+ *.sage.py
151
+
152
+ # Environments
153
+ .env
154
+ .envrc
155
+ .venv
156
+ env/
157
+ venv/
158
+ ENV/
159
+ env.bak/
160
+ venv.bak/
161
+
162
+ # Spyder project settings
163
+ .spyderproject
164
+ .spyproject
165
+
166
+ # Rope project settings
167
+ .ropeproject
168
+
169
+ # mkdocs documentation
170
+ /site
171
+
172
+ # mypy
173
+ .mypy_cache/
174
+ .dmypy.json
175
+ dmypy.json
176
+
177
+ # Pyre type checker
178
+ .pyre/
179
+
180
+ # pytype static type analyzer
181
+ .pytype/
182
+
183
+ # Cython debug symbols
184
+ cython_debug/
185
+
186
+ # PyCharm
187
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
188
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
189
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
190
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
191
+ # .idea/
192
+
193
+ # Abstra
194
+ # Abstra is an AI-powered process automation framework.
195
+ # Ignore directories containing user credentials, local state, and settings.
196
+ # Learn more at https://abstra.io/docs
197
+ .abstra/
198
+
199
+ # Visual Studio Code
200
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
201
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
202
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
203
+ # you could uncomment the following to ignore the entire vscode folder
204
+ # .vscode/
205
+ # Temporary file for partial code execution
206
+ tempCodeRunnerFile.py
207
+
208
+ # Ruff stuff:
209
+ .ruff_cache/
210
+
211
+ # PyPI configuration file
212
+ .pypirc
213
+
214
+ # Marimo
215
+ marimo/_static/
216
+ marimo/_lsp/
217
+ __marimo__/
218
+
219
+ # Streamlit
220
+ .streamlit/secrets.toml
@@ -0,0 +1 @@
1
+ Do not make mistakes.
@@ -0,0 +1,132 @@
1
+ # Contributing
2
+
3
+ Thanks for considering contributing! We welcome all quality contributions, including AI-generated PRs.
4
+
5
+ ## Quick Guidelines
6
+
7
+ - **New Features:** Please submit an Issue tagged with the `enhancement` label before opening a Pull Request so we can discuss it first.
8
+ - **Small Fixes & Bugs:** Feel free to open a Pull Request directly!
9
+
10
+ Welcome! This guide will walk you through setting up your environment, running tests, making code changes, and contributing to the project step-by-step.
11
+
12
+ ## Prerequisites
13
+
14
+ Make sure you have **Python 3.8+** and `pip` installed on your system.
15
+
16
+ ## Step 1: Set Up Your Environment
17
+
18
+ Using a virtual environment keeps this project's dependencies isolated from the rest of your system.
19
+
20
+ ### Linux & macOS (Bash / Zsh)
21
+
22
+ Open your terminal in the root directory of the project and run:
23
+
24
+ ```bash
25
+ # 1. Create a virtual environment named 'venv'
26
+ python3 -m venv venv
27
+
28
+ # 2. Activate the environment
29
+ source venv/bin/activate
30
+ ```
31
+
32
+ ### Windows
33
+
34
+ Open your terminal in the root directory of the project and run the commands for your shell:
35
+
36
+ #### Option A: PowerShell
37
+
38
+ ```powershell
39
+ # 1. Create the virtual environment
40
+ python -m venv venv
41
+
42
+ # 2. Activate the environment
43
+ .\venv\Scripts\Activate.ps1
44
+ ```
45
+
46
+ > **PowerShell Script Error?** If you receive a script execution policy error when activating, run `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process` in your session, then try activating again.
47
+
48
+ #### Option B: Command Prompt (CMD)
49
+
50
+ ```cmd
51
+ :: 1. Create the virtual environment
52
+ python -m venv venv
53
+
54
+ :: 2. Activate the environment
55
+ venv\Scripts\activate.bat
56
+ ```
57
+
58
+ ---
59
+
60
+ - **Verify activation:** Your terminal prompt will display `(venv)` at the start of the line.
61
+ - **Exit the environment:** Type `deactivate` in your terminal when you are finished.
62
+
63
+ ## Step 2: Install the Package & Development Dependencies
64
+
65
+ To contribute code, you need to install the project in **editable mode** alongside development tools (like `pytest`).
66
+
67
+ Run the following command in your activated environment:
68
+
69
+ ```bash
70
+ pip install -e ".[dev]"
71
+ ```
72
+
73
+ > **Note:** The `-e` flag ("editable") ensures that any code changes you make locally are reflected immediately without needing to reinstall the package.
74
+
75
+ ## Step 3: Making Changes & Development Workflow
76
+
77
+ Follow this general workflow when adding features or fixing bugs:
78
+
79
+ ### 1. Create a New Branch
80
+
81
+ Keep your work organized by creating a dedicated git branch for your feature or fix:
82
+
83
+ ```bash
84
+ git checkout -b feature/my-new-feature
85
+ ```
86
+
87
+ ### 2. Make Your Code Edits
88
+
89
+ Modify or add files inside the project repository using your preferred code editor.
90
+
91
+ ### 3. Add Tests for Your Changes
92
+
93
+ If you are adding a feature or fixing a bug, add corresponding tests inside the `tests/` directory to ensure long-term stability.
94
+
95
+ ## Step 4: Run the Tests
96
+
97
+ Before committing your changes, run the test suite to make sure everything passes without breaking existing functionality.
98
+
99
+ ```bash
100
+ pytest
101
+ ```
102
+
103
+ ### Useful Pytest Options:
104
+
105
+ - Run a specific test file: `pytest tests/test_filename.py`
106
+ - Stop on the first failure: `pytest -x`
107
+ - Show verbose output: `pytest -v`
108
+
109
+ ## Step 5: Submitting Your Contribution
110
+
111
+ 1. **Stage and commit your changes:**
112
+
113
+ ```bash
114
+ git add .
115
+ git commit -m "Add short, descriptive summary of changes"
116
+ ```
117
+
118
+ 2. **Push your branch to GitHub:**
119
+
120
+ ```bash
121
+ git push origin feature/my-new-feature
122
+ ```
123
+
124
+ 3. **Open a Pull Request (PR):** Navigate to the project's repository on GitHub and click **Compare & pull request** to submit your changes for code review!
125
+
126
+ ## Troubleshooting & FAQ
127
+
128
+ | Issue | Solution |
129
+ | :----------------------------- | :---------------------------------------------------------------------------------------- |
130
+ | **`pytest` is not recognized** | Ensure your virtual environment `(venv)` is active and you ran `pip install -e ".[dev]"`. |
131
+ | **`python` command not found** | Try using `python3` instead, or verify Python is added to your system `PATH`. |
132
+ | **Changes not showing up** | Verify that `(venv)` is active and that the package was installed with the `-e` flag. |