It use predefined coordinates to draw Autocad figures, models etc. It create dxf output file , which can be opened in any CAD software like Librecad, Qcad etc.
Here Input file is coords.csv and output file is dia.dxf
dxfwrite is a python package. This package is used to draw figures , objects, models in any CAD software using python code. For using its feature, you have to import it in your python code after installation. When you run python script, then it will generate .dxf file, it will show your CAD model, This dxf file can be opened in any CAD software ( Qcad, Librecad, Draftsight). For creating models, you can give predefined coordinates or you can read them from .csv file or .txt file. But it will be beneficial if you get input from .csv file. Installtion of dxfwrite:
1.Download dxfwrite tar file from : https://pypi.python.org/pypi/dxfwrite/
2.Go to downloaded folder to install: $ python setup.py install
$ pip install dxfwrite
Doxygen is a tool that creates documentation of file by extracting comments from it. Doxygen can be used with any language like C, C++, Python, PHP etc. But each language and framework has different different comment style , comment style are also given in official site of doxygen http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html ,so use them carefully. Wrong comment style can effect your docnumentation. According to each language and framework, you have to change your .conf file, which you have created in project folder.
$ sudo apt-get install doxygen $ cd PYTHON //your project folder manpreet@hp:~/PYTHON$ doxygen -g my_doc.conf //create configuration file in projectfolder
Change my_doc.conf file according to language used. For PYTHON edit .conf file using below:
INPUT_FILTER = "python /path/to/doxypy.py" //(python/manpreet/PYTHON/doxypy.py) FILTER_SOURCE_FILES = YES HIDE_UNDOC_RELATIONS = NO OPTIMIZE_OUTPUT_JAVA = YES JAVADOC_AUTOBRIEF = YES MULTILINE_CPP_IS_BRIEF = YES DETAILS_AT_TOP = YES EXTRACT_ALL = YES EXTRACT_STATIC = YES SHOW_DIRECTORIES = YES SOURCE_BROWSER = YES ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 8 TOC_EXPAND = YES DISABLE_INDEX = YES GENERATE_TREEVIEW = YES
After this create python file and add comments (for example:python_class.py)
python_class.py """@package docstring Documentation for this module more detail """ class student: """documentation for class variable initialisation""" count=0 def profile(self, name, rollno): """documentation for function accessing input variables through self.""" self.name=name self.rollno=rollno student.count+=1 """display student number.""" print ' student no:', student.count print '\n' def display_profile(self): """function for showing output""" print ' name: ', self.name print ' rollno:', self.rollno """class object created""" s1=student() s2=student() """accessing functions using objects.""" s1.profile('man',123) s1.display_profile() s2.profile('an',121) s2.display_profile() print '\n' """show total students.""" print 'Total student:', student.count
After adding comments , Run commands on terminal
manpreet@hp:~/PYTHON$ doxygen python_class.py //it will create two folders /html and /latex in project folder PYTHON manpreet@hp:~/PYTHON$ firefox html/index.html
Now documentation is ready for python file python_class.py