Metadata-Version: 2.1
Name: cnki2bib
Version: 0.2.6
Summary: Converting the NoteExpress file (.net) exported by CNKI to BibTeX file (.bib)
Home-page: https://github.com/Vopaaz/CNKI_2_BibTeX
Author: Vopaaz
Author-email: liyifan945@163.com
License: UNKNOWN
Description: # CNKI_2_BibTeX
        
        Converting the NoteExpress (.net) file exported by CNKI (中国知网) to BibTeX (.bib) file.
        
        将中国知网导出的 NoteExpress 文献记录转换成 BibTeX 文献记录。
        
        [![Downloads](https://pepy.tech/badge/cnki2bib)](https://pepy.tech/project/cnki2bib)
        [![Downloads](https://pepy.tech/badge/cnki2bib/month)](https://pepy.tech/project/cnki2bib/month)
        ![GitHub](https://img.shields.io/github/license/vopaaz/cnki_2_bibtex)
        ![PyPI](https://img.shields.io/pypi/v/cnki2bib)
        [![Actions Status](https://github.com/Vopaaz/CNKI_2_BibTeX/workflows/CI/badge.svg)](https://github.com/Vopaaz/CNKI_2_BibTeX/actions)
        [![codecov](https://codecov.io/gh/Vopaaz/CNKI_2_BibTeX/branch/master/graph/badge.svg)](https://codecov.io/gh/Vopaaz/CNKI_2_BibTeX)
        
        <!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
        
        <!-- code_chunk_output -->
        
        - [CNKI_2_BibTeX](#cnki2bibtex)
          - [Getting Started](#getting-started)
            - [Prerequisites](#prerequisites)
            - [Installation](#installation)
            - [Using](#using)
            - [Finally...](#finally)
          - [Tricky Usage](#tricky-usage)
          - [Export NoteExpress .net File on CNKI](#export-noteexpress-net-file-on-cnki)
          - [Copy NoteExpress Entry content to the clipboard.](#copy-noteexpress-entry-content-to-the-clipboard)
        
        <!-- /code_chunk_output -->
        
        
        ## Getting Started
        
        ### Prerequisites
        
        - Python3
        
        ### Installation
        
        ```
        pip install cnki2bib
        ```
        
        ### Using
        
        Make sure it's in your `PATH`.
        
        ```
        cnki2bib [OPTIONS] [INPUTFILE]
        ```
        
        Arguments:
        
        - INPUTFILE:
          - The input .net file to be converted. If left blank, the contents in the clipboard will be used.
        
        Options:
        
        -  `-c, --copy / -nc, --no-copy`
            - Whether or not to copy the result to clipboard.
            - Default: `True`
        
        -  `-od, --outputDefault / -nod, --no-outputDefault`
            - Whether or not to create a default .bib file.
            - It has the same name as the source .net file in its directory.
            - Or if the input source is clipboard, it will be 'out.bib' in current working directory. 
            - Default: True
        
        -  `-o, --outputfile FILENAME`
            - Create a  certain output .bib file.
        
        -  `-f, --id-format [title|nameyear]`
            - Choose the format of the ID.
              - The first several words (or their pinyin) in the title
              - The first author (or the pinyin) plus year.
            - Default: `title`
            - Once you have assigned a format, your choice will be saved in `~/.cnki2bib.cfg`. It is unnecessary to type this choice since then.
        
        -  `--help`
            - Show this message and exit.
        
        
        ### Finally...
        
        Start using BibTeX to manage the literature references.
        
        ## Tricky Usage
        
        You can find `cnki2bib.exe` in your Python/Scripts and set it as the default program to open the .net file.
        
        Then when you double-click a .net file, the corresponding BibTeX Entries will be copied to your clipborad, and a .bib file would be created on the same directory.
        
        Use the console to check for Exception if it does not work as expected.
        
        
        ## Export NoteExpress .net File on CNKI
        
        ![FxL8Cq.png](https://s2.ax1x.com/2019/01/14/FxL8Cq.png)
        
        ## Copy NoteExpress Entry content to the clipboard.
        
        **You have to enable Flash to see the "Copy to clipboard" button.**
        
        ![FxL8Cq.png](https://github.com/SNBQT/share-images/blob/master/cnki2bib.png?raw=true)
        
        Then just run `cnki2bib` in the terminal. The corresponding BibTeX Entries will be copied to your clipboard, and an 'out.bib' file is created at the current directory. :smile:
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
