{"id":22124630,"url":"https://github.com/nblock/jasperstarter","last_synced_at":"2025-03-24T07:46:00.130Z","repository":{"id":35412545,"uuid":"39677285","full_name":"nblock/jasperstarter","owner":"nblock","description":"A Debian package for JasperStarter (bin)","archived":false,"fork":false,"pushed_at":"2019-12-27T09:11:56.000Z","size":120298,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-29T13:13:20.705Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nblock.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-07-25T07:59:56.000Z","updated_at":"2024-08-14T08:05:26.000Z","dependencies_parsed_at":"2022-09-17T15:02:43.667Z","dependency_job_id":null,"html_url":"https://github.com/nblock/jasperstarter","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nblock%2Fjasperstarter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nblock%2Fjasperstarter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nblock%2Fjasperstarter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nblock%2Fjasperstarter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nblock","download_url":"https://codeload.github.com/nblock/jasperstarter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245231598,"owners_count":20581684,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-01T15:48:53.231Z","updated_at":"2025-03-24T07:46:00.089Z","avatar_url":"https://github.com/nblock.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\r\nJasperStarter - Running JasperReports from command line\r\n--------------------------------------------------------\r\n\r\nJasperStarter is an opensource command line launcher and batch compiler for\r\n[JasperReports][].\r\n\r\nThe official homepage is [jasperstater.cenote.de][].\r\n\r\nIt has the following features:\r\n\r\n  * Run any JasperReport that needs a jdbc, csv, xml, json, jsonql or empty datasource\r\n  * Use with any database for which a jdbc driver is available\r\n  * Run reports with subreports\r\n  * Execute reports that need runtime parameters. Any parameter whose class has\r\n    a string constructor is accepted. Additionally the following types are\r\n    supported or have special handlers:\r\n    * date, image (see usage), locale\r\n  * Optionally prompt for report parameters\r\n  * Print directly to system default or given printer\r\n  * Optionally show printer dialog to choose printer\r\n  * Optionally show printpreview\r\n  * Export to file in the following formats:\r\n    * pdf, rtf, xls, xlsMeta, xlsx, docx, odt, ods, pptx, csv, csvMeta, html, xhtml, xml, jrprint\r\n  * Export multiple formats in one commanding call\r\n  * Compile, print and export in one commanding call\r\n  * View, print or export previously filled reports (use jrprint file as input)\r\n  * Can compile a whole directory of .jrxml files.\r\n  * Integrate in non Java applications (for example PHP, Python)\r\n  * Binary executable on Windows\r\n  * Includes JasperReports so this is the only tool you need to install\r\n  * \"Diskless\" operation using stdin and stdout for input data and output.\r\n\r\nRequirements:\r\n\r\n  * Java 1.8 or higher\r\n  * A JDBC 2.1 driver for your database\r\n\r\n\r\n### Quickstart\r\n\r\n  * Download JasperStarter from [Sourceforge][].\r\n  * Extract the distribution archive to any directory on your system.\r\n  * Add the _./bin_ directory of your installation to your searchpath (on\r\n    Windows: invoke setup.exe).\r\n  * Put your jdbc drivers in the _./jdbc_ directory of your installation or\r\n    use _\\--jdbc-dir_ to point to a different directory.\r\n\r\nInvoke JasperStarter with _\\-h_ to get an overview:\r\n\r\n    $ jasperstarter -h\r\n\r\nInvoke JasperStarter with _process \\-h_ to get help on the process command:\r\n\r\n    $ jasperstarter process -h\r\n\r\nExample with reportparameters:\r\n\r\n    $ jasperstarter pr report.jasper -t mysql -u myuser -f pdf -H myhost \\\r\n     -n mydb -o report -p secret -P CustomerNo=10 StartFrom=2012-10-01\r\n\r\nExample with hsql using database type generic:\r\n\r\n    $ jasperstarter pr report.jasper -t generic -f pdf -o report -u sa \\\r\n    --db-driver org.hsqldb.jdbcDriver \\\r\n    --db-url jdbc:hsqldb:hsql://localhost\r\n\r\nFor more information take a look in the docs directory of the distibution\r\narchive or read the [Usage][] page online.\r\n\r\n### Python Integration using public API\r\n\r\nJasperStarter exposes an API which can be used with [jpy][] to\r\nprovide direct access from Python:\r\n\r\n    #\r\n    # Load the JVM. See the jpy docs for details.\r\n    #\r\n    import jpyutil\r\n    jpyutil.init_jvm(jvm_maxmem='512M', jvm_classpath=['.../jasperstarter.jar'])\r\n    #\r\n    # Load the Java types needed.\r\n    #\r\n    import jpy\r\n    Arrays = jpy.get_type('java.util.Arrays')\r\n    File = jpy.get_type('java.io.File')\r\n    Report = jpy.get_type('de.cenote.jasperstarter.Report')\r\n    Config = jpy.get_type('de.cenote.jasperstarter.Config')\r\n    DsType = jpy.get_type('de.cenote.jasperstarter.types.DsType')\r\n    #\r\n    # Create the JasperStarter configuration. See Config.java for details.\r\n    #\r\n    config = Config()\r\n    config.setInput('jsonql.jrxml')\r\n    config.setOutput('contacts.pdf')\r\n    config.setDbType(DsType.json)\r\n    config.setDataFile(File('contacts.json'))\r\n    config.setJsonQuery('contacts.person')\r\n    config.setOutputFormats(Arrays.asList([]))\r\n    #\r\n    # Run the report. See Report.java for details.\r\n    #\r\n    instance = Report(config, File(config.getInput()))\r\n    instance.fill()\r\n    instance.exportPdf()\r\n\r\nSee the examples/python directory for a fuller example.\r\n\r\n### Release Notes\r\n\r\nSee [Changes] for a history of changes.\r\n\r\n\r\n#### Known Bugs\r\n\r\nFor upcoming issues see [Issues][]\r\n\r\n\r\n### Feedback\r\n\r\nFeedback is always welcome! If you have any questions or proposals, don't\r\nhesitate to write to our [discussion][] forum.\r\nIf you found a bug or you are missing a feature, log into our [Issuetracker][]\r\nand create a bug or feature request.\r\n\r\nIf you like the software you can write a [review][] :-)\r\n\r\n\r\n### Development\r\n\r\nThe sourcecode is available at [bitbucket.org/cenote/jasperstarter][], the\r\nproject website is hosted at [Sourceforge][].\r\n\r\nJasperStarter is build with [Maven][]. \r\n\r\nOn Linux 64 bit the launch4j-maven-plugin may fail. In this case, may you need the following libs in a 32 bit version:\r\n\r\n  * z1\r\n  * ncurses5\r\n  * bz2-1.0\r\n\r\nInstall on Ubuntu 14.04 or above:\r\n\r\n    $ sudo apt-get install lib32z1 lib32ncurses5 lib32bz2-1.0\r\n\r\nInstall on Fedora 27 or above:\r\n\r\n    $sudo dnf install ncurses-compat-libs.i686\r\n\r\nTo get a distribution package run:\r\n\r\n    $ mvn package -P release\r\n\r\nor if you build from the current default branch you better use:\r\n\r\n    $ mvn package -P release,snapshot\r\n\r\n**Attention! You cannot execute** `target/jasperstarter.jar`\r\n**without having it\\'s dependencies in** `../lib` ! See **dev** profile below!\r\n\r\nIf you want to build the Windows setup.exe, you need to have _nsis_ in your\r\nsearch path (works on linux too, you can find a compiled release in the \r\nsourceforge download folder _build-tools_ for your convenience)\r\nan add the **windows-setup** profile to your build:\r\n\r\n    $ mvn package -P release,windows-setup\r\n\r\nor\r\n\r\n    $ mvn package -P release,windows-setup,snapshot\r\n\r\nWhile developing you may want to have a quicker build. The **dev** profile\r\nexcludes some long running reports and the compressed archives. Instead it puts\r\nthe build result into _target/jasperstarter-dev-bin_.\r\n\r\n    $ mvn package -P dev\r\n\r\nNow you can execute JasperStarter without IDE:\r\n\r\n    $ target/jasperstarter-dev-bin/bin/jasperstarter\r\n\r\nor\r\n\r\n    $ java -jar target/jasperstarter-dev-bin/lib/jasperstarter.jar\r\n\r\nDuring development you might want not to be annoyed by tests. So the following\r\noptions are useful:\r\n\r\n    $ mvn package -P dev -D skipTests\r\n\r\nor\r\n\r\n    $ mvn package -P dev -D maven.test.failure.ignore=true\r\n\r\nTo run JasperStarter from within your IDE add _\\--jdbc-dir jdbc_ to the argument\r\nlist of your run configuration. Otherwise you will get an error:\r\n\r\n    Error, (...)/JasperStarter/target/classes/jdbc is not a directory!\r\n\r\nPut your jdbc drivers in the _./jdbc_ directory of the project to invoke\r\nJasperStarter from within your IDE to call up a database based report.\r\n\r\n\r\n### License\r\n\r\nCopyright 2012-2015 Cenote GmbH.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n   http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n\r\n[jasperstater.cenote.de]:http://jasperstarter.cenote.de/\r\n[JasperReports]:http://community.jaspersoft.com/project/jasperreports-library\r\n[Maven]:http://maven.apache.org/\r\n[Sourceforge]:http://sourceforge.net/projects/jasperstarter/\r\n[bitbucket.org/cenote/jasperstarter]:http://bitbucket.org/cenote/jasperstarter\r\n[review]:http://sourceforge.net/projects/jasperstarter/reviews\r\n[discussion]:http://sourceforge.net/p/jasperstarter/discussion/\r\n[Issuetracker]:https://cenote-issues.atlassian.net/browse/JAS\r\n[Usage]:http://jasperstarter.sourceforge.net/usage.html\r\n[Issues]:https://cenote-issues.atlassian.net/browse/JAS\r\n[Changes]:changes.html\r\n[jpy]:https://github.com/bcdev/jpy","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnblock%2Fjasperstarter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnblock%2Fjasperstarter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnblock%2Fjasperstarter/lists"}