Showing posts with label generation. Show all posts
Showing posts with label generation. Show all posts

How to auto generate requrirements.txt for Python required pakcages for a project

requirements.txt is a text file including a set of dependencies that are required in order to make a python application to work. For example, it is important to deliver the requirements.txt when delivering your python code to someone to install required packages to run your code easily. 

 There are two tools such as 1) freeze and 2) pipreqs. However, freeze stores all packages in the environment of your code which might overinstall other ones that your code does not use. In contrast, pipreqs only stores the packages that are installed with pip install in your code environment.

$ pip install pipreqs
$ pipreqs /path/to/project

How to generate JavaDoc in Eclipse ?

  1. Open the Eclipse project
  2. Select Project –> Generate JavaDoc
enter image description here
  1. At first step of the wizard, you can define settings for:
  3.1 path for the javadoc.exe tool from the JDK;
  3.2 project resources for which to generate JavaDoc;
  3.3 classes and methods for which to generate JavaDoc based on their visibility;
  3.4 location of the JavaDoc (by default it will be placed in the doc folder in the project location)
enter image description here
  1. At second step you can make settings regarding:
     4.1 documentation structure;
     4.2 JavaDoc tags to be processed;
     4.3 other resources(archives, projects) used in project to be included in the documentation;
     4.4 another CSS style sheet for the documentation;
enter image description here
  1. At the last step you can save the settings in an Ant script for future use. enter image description here