Metadata-Version: 2.1
Name: pycharm_debug
Version: 0.4.0
Summary: Connection helper for PyCharm Python Remote Debugging.
Home-page: https://github.com/ldunham1/pycharm_debug
Author: Lee Dunham
Author-email: leedunham@gmail.com
License: MIT
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown

# pycharm_debug
A module to connect a Python interpreter to a running 
[PyCharm remote debugging server](https://www.jetbrains.com/help/pycharm/remote-debugging-with-product.html#remote-debug-config). 

Tested in DCC Applications;
- Maya
- Motionbuilder
- 3D Studio Max
- Blender
- Houdini
- Cascadeur


## Usage
1. Determine an available port number ie : **7520**
2. Start a remote debug configuration in PyCharm : [link](https://www.jetbrains.com/help/pycharm/remote-debugging-with-product.html#remote-debug-config)
3. Run the following in the target Python interpreter :
```python
import pycharm_debug
pycharm_debug.start(port=7520)
# True
```

If the `pydevd` module is not yet discoverable for import, the latest PyCharm install is used instead.  
This convenience allows developers to frequently update PyCharm without needing to re-add the new install location for `pydevd`.


## Functions
### `pycharm_debug.start(port=7200, host='localhost')`


## Requirements
This module requires the `pydevd` module, which is part of the PyCharm installation.  
If not already available, it will attempt to automatically locate and import the 
appropriate `pydevd` module based on the installed PyCharm versions.


## Compatibility
This module has been tested on Windows. Support for other operating systems may be added in the future.


## License
This project is licensed under the [MIT License](LICENSE).


## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
