tjsoler / comic-vine-scraper Goto Github PK

I am maintaining the Comic Vine Scraper project, but I am no longer actively adding new features.

The latest release of this app is functional as of February 2018, and should remain usable for the foreseeable future. As my schedule permits, I will continue to provide minor maintenance patches and bugfixes to keep things running smoothly. I will not be adding new features, however, and I do not have time to review or maintain large pull requests.

The code here provides a solid example of how to properly use the Comic Vine API, should you happen to want to create your own project that does that. Also, if you are a relatively experienced python developer and you're interested in taking over Comic Vine Scraper, please feel free create your own fork and run with it!

For those of you who've used and supported Comic Vine Scraper over the last 10 years, you have my sincere thanks for all your efforts and kind words. Here's to 10 more!

-Cory

All documentation about this project, including the latest downloads and installation instructions can be found on the Comic Vine Scraper Wiki page.

This project is written for Windows, using IronPython and the .NET library. It displays WinForms graphics and makes heavy use of the ComicVine RESTful API. It is a plugin for the ComicRack comic book reader, which is a standalone Windows desktop application. Except during development (see below), Comic Vine Scraper does not run outside of ComicRack's plugin environment.

This project is currently set up to compile and run in the VS Code IDE using the Microsoft Python Extension with properly installed versions of both Python (for parsing source code in the IDE) and IronPython (for running the code using .NET assemblies). In other words, you should have ipy.exe, python.exe, and pylint.exe working on your command-line before you get started.

You should also get Java and Ant (i.e. java.exe and ant.exe) installed and running, since this project uses Ant to build, test, and run the plugin during development.

All code is written for Python version 2, not 3.

At this point, I am not accepting pull requests. Comic Vine Scraper is a stable, mature project and most of the work on it these days is maintenance and bug fixing. I may accept well-written pull requests for straightforward bug fixes, but please contact me before you start doing any significant work. I don't want to waste your time.

This project is created and distributed under the Apache 2.0 License. This is an open source license, so you are welcome to create, build, and maintain your own fork of the codebase if you have a major enhancement that you want to add, or a wild new direction that you'd like to take the project.

Unless required by applicable law or agreed to in writing, software 
distributed under this License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.